Audience
This site targets primarily software developers or 'end users' that develop their own automation.
The data within the API should be used by each company in the horticulture sector, whether fulfilling a role as:
- supplier
- buyer
- agent
- logistic agent
- sustainability agent
In order to use standardized product environmental footprint data in multiple floriculture sector processes, software that implement the FloriPEF category rules should implement a standardized API in order to get FSI-compliancy.
Please take a look at the Glossary and Class model to see the available data .
Glossary
The glossary on this page describes all nouns that can be found in our API.
A complete Glossary of nouns used in the whole horticulture sector can be found at our generic website, see "Ornamental Horticultural Industry Glossary" under the heading Industry.
Footprint
The footprint of a product containing all known stages from cradle to grave in the FloriPEF result matrix.
FootprintCategory
A category represents a footprint category as described in the vertical axis of the FloriPEFCR results matrix. The API is currently limited to the 16 categories in the matrix.
The footprint categories:
- Acidification
- ClimateChange
- EcotoxicityFreshwater
- ParticulateMatter
- EutrophicationMarine
- EutrophicationFreshwater
- EutrophicationTerrestrial
- HumanToxicityCancer
- HumanToxicityNonCancer
- IonisingRadiation
- LandUse
- OzoneDepletion
- PhotochemicalOzoneFormation
- ResourceUseFossils
- ResourceUseMineralsAndMetals
- WaterUse
FootprintPlan
A plan is a set of commercial products that are subject to the same footprint calculation.
FootprintStage
A stage represents a stage as described in the horizontal axis of the FloriPEFCR results matrix. The API is currently limited to the 8 stages in the matrix.
The footprint stages:
- RawMaterials
- Cultivation
- Distribution
- Storage
- Auction
- Retail
- UseStage
- EndOfLife
numberOfUnits
A cell in the FloriPEFCR results matrix.
Product
The commercial product with the calculated footprint is identified in by a grower specified productIdentifier (GUID). Product also have a readable name and could be grouped.
Class model
Operations
- Retrieve PEF-score (the FloriPEFCR results matrix) of a single product
- Endpoint implemented by any FSI-compliant PEF-tool
- Upload a plan with the PEF-score of multiple products to another system
- Endpoint implemented e.g. by a future Floricode PEF-register and/or by Floriday
- FSI-compliant PEF-tools must be able to call this end-point in order to synchronize data with the other system
- Retrieve all plans of a grower (based on grower API-key)
- Endpoint implemented by any FSI-compliant PEF-tool
Authentication
In the pilot fase we will start with Basic Authentication for authentication on the endpoints.
In production we will use OAuth2.0 where Floricode provides ClientID and Client Secret for obtaining an access token for authentication on the endpoints