Skip to main content
Version: 1.0.0

API Key Management Service

Create, list, renew, and revoke API keys used for x-api-key authentication.

Shippers vs carriers​

  • Shippers can manage keys in the Cargors Portal (Integrations → Cargors API) or via this API.
  • Carriers do not have portal API key management. They generate and manage keys only via this API (HTTP Basic Auth).

See the Shipper and Carrier API key guides in the docs for role-specific steps.

DEVELOPMENT & PRODUCTION Flow​

Keys call the same API host (https://app.cargors.com/api/edi). Use keyMode to choose how the key behaves:

  • DEVELOPMENT: validates payloads and returns sample responses for shipment-creation endpoints. No real shipment or order is created.
  • PRODUCTION: creates real shipments / runs live operations.

For shippers, PRODUCTION key generation requires Go live access. Until that is enabled, generate a DEVELOPMENT key to test your integration.

Ready to go live? Once your integration testing is complete, contact Cargors Operations at operations@cargors.com to request Go live access.

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

basic