API Environments

A sneak peak at available CargoDocs Customer API environments for the developers

CargoDocs Customer API has support for three environments for partners to test out their applications.

Sandbox

Sandbox API is primarily used for initial setups and testing purposes only. Customers signing onto to CargoDocs initiate their development using this set of APIs.

HTTP

https://api-test.cargodocs.com/vX/

UAT

UAT APIs are connected to non-live real like data for trail partners. This environment is also used to test out new API releases by our existing customers to ensure their system does not break down with the new releases.

HTTP

https://api-uat.cargodocs.com/vX/

Production

All customer's production applications point to Production API ultimately. The latest API release is always deployed over to the Production once thoroughly tested over the UAT environments.

HTTP

https://api.cargodocs.com/vX/

📘

API Version

• The API version is appended next to the base URL. The current CargoDocs Customer APIs current version is v3.
  • X in vX denotes the version number.

🚧

Switch Environments

• In order to allow users to test our products, endpoints on this documentation point to the Sandbox environments (URL: https://api-test.cargodocs.com/vX/) and UAT environment (URL: https://api-uat.cargodocs.com/vX/).
  • Once you obtain the user credentials for the production environment post app development, you must switch the URLs of endpoints to the Production environment (URL: https://api.cargodocs.com/vX/)