External Integration API
Create API Key
Authenticate with a company main-account login and password to generate a new API key. The key is returned exactly once — store it immediately. Only the primary company account can issue keys; driver and sub-accounts are rejected with a 403.
Authentication
| Header | Required | Purpose |
|---|---|---|
provider-token | Yes | Provider authentication token |
Endpoint
POST/api/externalservice/create-api-key
Request Body Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
login | string | Yes | Company account username or email address |
password | string | Yes | Account password |
usdot | string | Yes | USDOT number of the company account |
Example Request
bash
Response 201 Created
json
{
"apiKey": "ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"createdAt": "2026-06-25T10:00:00.000Z"
}| Field | Type | Description |
|---|---|---|
apiKey | string | The generated key — shown only once, store it immediately |
createdAt | string (ISO 8601) | Timestamp of key creation |
Error Responses
| Status | Meaning |
|---|---|
| 400 | Missing or invalid request body |
| 401 | Invalid login credentials |
| 403 | Account is not a primary company account |
Contact the support team for access credentials or integration assistance.