Getting Started with the API
Getting started
You can view the APIs by looking at this site's API reference section. Once you are ready to start calling the APIs, you can request credentials by emailing [email protected] with the name of your organization and a list of developer emails that need access. Once set up, the developers can log into this portal to retrieve their API keys and call the APIs.
Description of the APIs
The API is divided into four categories of calls:
| Category | Usage |
|---|---|
| System Status | The System Status call can be used to determine if the API is up and running and will return the version of the API. This can be called from time to time to ensure the uptime of the API |
| Products | The product call will list all of the products available to order. They include the brand names, images, and load values. Depending on the brand, there may be 'fixed' load values or variable load values. Please see the terminology section for more details. |
| Orders | Orders where you can place a new order in the system or retrieve a single order or a list of orders. |
| Webhooks | You must implement the mandatory fulfillment webhook to receive the fulfillment details of the orders. Please see the Webhooks section for more details. |
Updated over 2 years ago