INTEGALL voor ontwikkelaars

De INTEGALL-API voor uw ERP, TMS of WMS: wat er bestaat, het adres, de eerste oproep en wat (nog) niet bestaat.

Laatst bijgewerkt: Hulp nodig? Contacteer support

Met de INTEGALL-API koppelt een transportbedrijf zijn eigen ERP, TMS of WMS aan INTEGALL. De API is een REST-API met JSON, versie v1. Deze pagina's beschrijven enkel wat vandaag echt bestaat.

Wat de API kan#

BewerkingMethode en padBevoegdheid
GezondheidscontroleGET /v1/pinggeen sleutel nodig
Technische beschrijving (OpenAPI 3.1)GET /v1/openapi.jsongeen sleutel nodig
Zendingen oplijstenGET /v1/shipmentsshipments:read
Eén zending met tijdlijnGET /v1/shipments/{ref}shipments:read
Een transport aanvragenPOST /v1/shipment-requestsshipments:write
Definitieve facturen oplijstenGET /v1/invoicesinvoices:read

Daarnaast stuurt INTEGALL webhooks bij drie gebeurtenissen: de status van een zending wijzigt, een factuur wordt definitief, een factuur wordt betaald.

Het adres#

https://api.integall.com/functions/v1/api-v1

Alle paden hierboven komen achter dit adres, bijvoorbeeld https://api.integall.com/functions/v1/api-v1/v1/shipments. Het exacte adres staat ook in het bedrijfspaneel bij API en webhooks (Adres van de API).

In drie stappen#

  1. De eigenaar of een beheerder van het transportbedrijf maakt een API-sleutel in het bedrijfspaneel. Zie API-sleutels en webhooks.
  2. Controleer dat de API bereikbaar is:
curl https://api.integall.com/functions/v1/api-v1/v1/ping
  1. Doe een eerste oproep met de sleutel:
curl -H "Authorization: Bearer $INTEGALL_API_KEY" \
  "https://api.integall.com/functions/v1/api-v1/v1/shipments?limit=10"

Zet de sleutel in een omgevingsvariabele (INTEGALL_API_KEY), nooit in uw broncode.

Regels#

  • Gebruik de API enkel vanaf een server. Zet een sleutel nooit in een browser of mobiele app.
  • Elke sleutel hoort bij één transportbedrijf en ziet enkel de gegevens van dat bedrijf.
  • Begin met een proefsleutel (rr_test_…): die leest uw echte gegevens, maar schrijft niets weg.
  • Voorbeeldgegevens (gemarkeerd als voorbeeld in het paneel) komen nooit in de API.

Wat (nog) niet bestaat#

  • Geen API voor schrijven buiten aanvragen: ritten aanmaken, wijzigen of facturen maken kan enkel in het bedrijfspaneel. Een aanvraag via de API komt binnen bij Aanvragen en het kantoor maakt er een rit van.
  • Geen eFTI Gate-koppeling: INTEGALL is geen gecertificeerd eFTI-platform en is niet gekoppeld aan een eFTI Gate van een lidstaat. Er is geen interface voor overheden of eFTI Gates. Zie eFTI.
  • NAV-API (gepland): de API voor vrachtwagenroutes en adressen is gebouwd, maar de NAV-server is nog niet in gebruik. Zie NAV-API.
  • Webhooks beheren via de API: de bevoegdheid webhooks:manage bestaat, maar in v1 gebruikt geen enkel pad ze. Webhooks beheert u in het bedrijfspaneel.

Verder lezen#