eCert – eCertification Platform
This document demonstrates the step by step process of setting up and using the eCert Web API methods to perform an application for an electronic Phytosanitary certificate from the request to the issuance of the certificate. To interact with the eCert Web API, client systems need to be registered.
Download the latest eCert Web API Guide
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 Web API for ePhyto requests are as follows:
Refer to the How to Connect to Web API Document
To test the eCert Web API endpoints users can use 3rd party tools like Swagger or Postman. These tools will help the user get a feel of what the endpoint parameters look like, as well as view the responses in various formats. Following is the endpoint to the QA eCert API to see the available standards:
PLEASE NOTE: this is currently reserved for Fruit.
Used to apply for ePhyto certificate by submitting all the necessary information to process the application.
Request (xml, json):
To update a draft application, submit the same object as that for making an application as shown above in the Apply for ePhyto Certificate section.
Endpoint: refer to Apply for ePhyto Certificate section.
Request (xml, json): refer to Apply for ePhyto Certificate section.
Response: refer Apply for ePhyto Certificate section.
Note: To simply add new documents without changing any other application data, please refer to the Add Documents section of this document
The request parameters to pay special attention to when submitting for an update are as follows:
ApplicationReferenceNo: Specify the application reference number to update
ApplicationStatus: “U” indicates update, if not specified a new application will be created
SequenceNumeric(Consignment Level): Uniquely identifies each consignment on an application
Used to retrieve the full details of an eCert application.
Request (query parameter):
Used to retrieve a pdf copy of the ePhyto certificate.
PLEASE NOTE: This feature is reserved for future purposes for cooling data.
Used to retrieve additional cooling data information for the application.
Used to post additional information for the certification process such as cooling data
Used to get the status of a phyto application after it has been submitted.
Used to add documents to an existing draft application
Used to get a list of available agreements
Used to get a list of available agreements by agreement code
Used to get the list of standards by specifying the standard name
Used to retrieve a list of all available standards