API Environments

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

CargoDocs Customer API supports 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.

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.

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

Production

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

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