Skip to main content

Shipper Generate API key

Shippers can create and manage API keys in either of these ways:

  1. Cargors Portal (recommended)
  2. Key management REST API

Testing and live calls use the same host (https://app.cargors.com/api/edi). Choose Development or Production when you create the key (keyMode). Start with Development so you can validate payloads without creating real shipments. See Development vs Production API keys.

Option A — Cargors Portal (recommended)​

  1. Sign in at https://portal.cargors.com/.
  2. In the top navigation, open NEW RFQ → Integrations, choose the Integrations tab, select Cargors API, and authenticate with your portal email and password when asked.
  3. Use + Generate API Key, select Development (for testing) or Production (after Go live access), and copy the key for the x-api-key header. The name is filled from the selected mode and the expiry defaults to 3 years from today.

Manage keys in the portal​

  • Generate: + Generate API Key → choose Development or Production → confirm. Copy and store the key securely when shown.
  • Copy: use the copy control next to the key when available.
  • Renew: extend expiry on an existing key.
  • Revoke: delete a key permanently; it can no longer be used.

Option B — Key management REST API​

Use the key management endpoints below to create, list, renew, or revoke keys. Authenticate with HTTP Basic Authentication.

Endpoint: POST https://app.cargors.com/api/edi/api-keys

Required headers:

  • Authorization: Basic base64<username:password>
  • Content-Type: application/json

Example payload:

{
  "keyName": "DesiredKeyName",
  "expiryDate": "YYYY-MM-DD",
  "keyMode": "DEVELOPMENT"
}

Use "keyMode": "DEVELOPMENT" while integrating. Use "keyMode": "PRODUCTION" only after Cargors has enabled Go live access on your shipper account.

cURL example:

curl -X POST "https://app.cargors.com/api/edi/api-keys" \
     -H "Authorization: Basic <YourBase64EncodedCredentials>" \
     -H "Content-Type: application/json" \
     -d '{
    "expiryDate": "2026-01-19",
    "keyName": "Test Key",
    "keyMode": "DEVELOPMENT"
}'

Example response:

{
  "uuid": "65c2dcb45...",
  "apiKey": "5baa4bdc60ef59df...",
  "keyName": "Test Key",
  "expiryDate": "2025-01-19",
  "keyMode": "DEVELOPMENT"
}

API reference​

Next step​

Continue with the Shipper usage guide.