External Integration API
Trucks — External Integration API
This API provides real-time access to unit assignments, enabling partners to view truck assignments alongside driver and co-driver details.
Platform
| Base Read API URL |
|---|
https://read.sbaeld.com |
Authentication
Two headers are required for every request:
| Header | Required | Purpose |
|---|---|---|
x-api-key | Yes | API key |
provider-token | Yes | Provider authentication token |
Current Units Endpoint
Retrieves a real-time snapshot of all units with assigned personnel.
GET/api/externalservice/current-units/:usdot
Query Parameters
| Parameter | Required | Description |
|---|---|---|
usdot | Yes | Company USDOT number (path parameter) |
page | No | Pagination page number |
perPage | No | Number of results per page |
is_active | Yes | Boolean filter — true or false |
Example Request URL
GET https://read.sbaeld.com/api/externalservice/current-units/123456?page=1&perPage=10&is_active=true
Response Structure
Returns an array of unit objects with their assigned driver and co-driver information, along with pagination metadata.
json
{
"data": [
{
"id": "string(uuid)",
"vin": "string",
"truck_number": "string",
"driver": {
"id": "string",
"first_name": "string",
"second_name": "string"
},
"codriver": {
"id": "string",
"first_name": "string",
"second_name": "string"
}
}
],
"meta": {
"page": 1,
"perPage": 10,
"total": 100,
"totalPages": 10
}
}Example cURL Request
bash
curl --location 'https://read.sbaeld.com/api/externalservice/current-units/123456?page=1&perPage=10&is_active=true' \
--header 'x-api-key: <your-api-key>' \
--header 'provider-token: <your-provider-token>'This endpoint gives integrators access to current truck assignments along with associated driver and co-driver information. Contact the support team for credentials or integration assistance.