INTEGALL for developers
The INTEGALL API for your ERP, TMS or WMS: what exists, the address, the first call and what does not exist (yet).
With the INTEGALL API a transport company connects its own ERP, TMS or WMS to INTEGALL. The API is a REST API with JSON, version v1. These pages only describe what really exists today.
What the API can do#
| Operation | Method and path | Permission |
|---|---|---|
| Health check | GET /v1/ping | no key needed |
| Technical description (OpenAPI 3.1) | GET /v1/openapi.json | no key needed |
| List shipments | GET /v1/shipments | shipments:read |
| One shipment with timeline | GET /v1/shipments/{ref} | shipments:read |
| Request a transport | POST /v1/shipment-requests | shipments:write |
| List final invoices | GET /v1/invoices | invoices:read |
In addition, INTEGALL sends webhooks for three events: the status of a shipment changes, an invoice becomes final, an invoice is paid.
The address#
https://api.integall.com/functions/v1/api-v1All paths above go after this address, for example https://api.integall.com/functions/v1/api-v1/v1/shipments. The exact address is also shown in the company panel under API and webhooks (API address).
In three steps#
- The owner or an administrator of the transport company creates an API key in the company panel. See API keys and webhooks.
- Check that the API is reachable:
curl https://api.integall.com/functions/v1/api-v1/v1/ping- Make a first call with the key:
curl -H "Authorization: Bearer $INTEGALL_API_KEY" \
"https://api.integall.com/functions/v1/api-v1/v1/shipments?limit=10"Put the key in an environment variable (INTEGALL_API_KEY), never in your source code.
Rules#
- Only use the API from a server. Never put a key in a browser or mobile app.
- Every key belongs to one transport company and only sees that company's data.
- Start with a test key (
rr_test_…): it reads your real data but writes nothing. - Sample data (marked as sample in the panel) never appears in the API.
What does not exist (yet)#
- No API for writing beyond requests: creating or changing trips or creating invoices is only possible in the company panel. A request through the API arrives under Requests and the office turns it into a trip.
- No eFTI Gate connection: INTEGALL is not a certified eFTI platform and is not connected to an eFTI Gate of a member state. There is no interface for authorities or eFTI Gates. See eFTI.
- NAV API (planned): the API for truck routes and addresses has been built, but the NAV server is not in use yet. See NAV API.
- Managing webhooks through the API: the permission
webhooks:manageexists, but no path inv1uses it. You manage webhooks in the company panel.