eCert – eCertification Platform
The Agreements Web API is designed to expose detailed information for agreements. An agreement is a set of rules for a product going to a market. This document is designed to guide vendors and other interested stakeholders on how to consume and interpret the agreements data.
There are three versions of the API that are available at a time and these are stated below:
All requests are sent with the version of the API in the URL or the consumer can to call the API through a custom request header as below:
The current version of the API will be displayed on the API’s Swagger page. The swagger page will display the available endpoints depending on the selected version.
When a new version becomes available, notifications will be sent out to all the relevant parties with a changelog of the new changes and features. The Swagger page will be updated accordingly with these new features. The links to the swagger pages are as follows:
The pre-conditions for a client system to be able to consume the eCert Agreements, Requirements and Safeguards Web API are as follows:
Refer to the UAS Web API How to Connect
Used to retrieve a list of all the Agreements in the eCert system by AgreementCode, CommodityCode, CountryCode, and Sector
Endpoint:
Request (xml, json):
The parameters for the above endpoint are as follows:
Response:
Returns a list of all the Agreements that correspond to the supplied parameter
[ { "AgreementId": 72, "AgreementCode": "AGM0014", "AgreementName": "CITRUS_EU", "StartDate": "2019-09-26T00:00:00", "EndDate": "2020-09-25T00:00:00", "Ranking": 100, "Sectors": [ { "Name": "Horticulture (Fruit & Berries)", "HSChapter": "08" } ], "Countries": [ { "MasterListName": "Country", "Name": "Netherlands", "Code": "NL" } ], "Commodities": [ { "MasterListName": "Commodity", "Name": "GRAPEFRUIT", "Code": "GF" } ], "FlexiFields": [ { "Name": "PPECB Signed Addendum", "IsRequired": "true" } ], "DocumentTypes": [ { "Code": "110", "Name": "PPECB Signed Addendum", "IsPrintable": false, "IsRequired": true }, { "Code": "112", "Name": "PPECB Export Certificate", "IsPrintable": true, "IsRequired": false }, { "Code": "107", "Name": "Other", "IsPrintable": true, "IsRequired": false } ] } ]
Used to retrieve a list of all the Agreements in the eCert system
Used to retrieve an Agreement based on supplied AgreementCode
The parameters for the above endpoint are as follows;