Skip to main content

Carrier Generate API key

Carriers do not have portal access for API key management. Generate and manage keys only via the key management REST API using the credentials Cargors provides (HTTP Basic Auth).

Create a key via API​

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

Required headers:

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

Example payload:

{
  "keyName": "Carrier Integration Key",
  "expiryDate": "YYYY-MM-DD",
  "keyMode": "PRODUCTION"
}

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": "Carrier Integration Key",
    "keyMode": "PRODUCTION"
}'

Example response:

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

Use the key on carrier endpoints​

Send on every carrier API request:

  • x-api-key: <API_KEY_VALUE>
  • Content-Type: application/json (or multipart/form-data for POD uploads)

API base URL: https://app.cargors.com/api/edi

Manage keys (list, renew, revoke)​

Use the same Basic Auth credentials with these endpoints:

Next step​

Continue with the Carrier usage guide (receive shipments, update status, upload POD).