API-sleutels en webhooks

Sleutels aanmaken voor uw eigen ERP, TMS of WMS, webhooks instellen, en NAV-sleutels voor routes en adressen.

Laatst bijgewerkt: Hulp nodig? Contacteer support

INTEGALL heeft twee soorten sleutels voor externe systemen:

  • API-sleutels en webhooks voor de INTEGALL-API: zendingen lezen, transporten aanvragen, facturen lezen en berichten ontvangen bij een gebeurtenis. U vindt ze onderaan InstellingenIntegraties, op de kaart API en webhooks.
  • NAV-sleutels voor de INTEGALL NAV-server (routes en adressen). U vindt ze op InstellingenAPI-sleutels.

De technische beschrijving voor uw IT-partner staat bij Ontwikkelaars (API).

Een API-sleutel aanmaken#

  1. Ga naar InstellingenIntegraties en scroll naar API en webhooks. Daar staat ook het Adres van de API en een link naar de Technische beschrijving (OpenAPI).
  2. Kies + Nieuwe API-sleutel.
  3. Vul een Naam (waarvoor dient deze sleutel?) in, bijvoorbeeld ERP koppeling.
  4. Kies de Bevoegdheden: Zendingen lezen, Transporten aanvragen, Facturen lezen, Webhooks beheren. Geef enkel wat het systeem nodig heeft.
  5. Vink eventueel Proefsleutel (schrijven wordt enkel nagekeken, niets opgeslagen) aan om eerst te testen.
  6. Kies hoe lang de sleutel Geldig is: tot ik hem intrek, 30, 90 of 365 dagen.
  7. Vul de code uit uw authenticator-app in en kies Sleutel aanmaken.
  8. De sleutel wordt maar één keer getoond. Kopieer hem met Kopiëren, bewaar hem veilig (bijvoorbeeld in een wachtwoordkluis) en kies Ik heb hem bewaard.

U kunt hoogstens 20 actieve sleutels hebben.

Sleutels beheren#

De tabel toont per sleutel de Naam, de Bevoegdheden (met Proef voor een proefsleutel), de Status (Actief, Ingetrokken of Verlopen) en het Gebruik: wanneer de sleutel laatst gebruikt werd en hoeveel oproepen in de laatste 24 uur.

Met Intrekken en Ja, intrekken werkt een sleutel meteen niet meer. Een sleutel vervangen doet u zo: maak een nieuwe sleutel, zet hem in uw systeem en trek daarna de oude in.

Webhooks#

Met een webhook stuurt INTEGALL een bericht naar uw adres zodra er iets gebeurt. Elk bericht is ondertekend (X-INTEGALL-Signature).

  1. Kies + Nieuwe webhook.
  2. Vul het Adres (https) in, bijvoorbeeld https://erp.uwbedrijf.be/integall. Het adres moet https zijn, met een publieke domeinnaam (geen IP-adres of interne naam).
  3. Kies de Gebeurtenissen: Status van een zending gewijzigd, Factuur definitief en Factuur betaald.
  4. Vul de code uit uw authenticator-app in en kies Webhook toevoegen.
  5. Het ondertekeningsgeheim wordt maar één keer getoond. Geef het aan uw IT-partner; die controleert er elk bericht mee.

Per webhook ziet u de laatste bezorging met HTTP-status, hoeveel berichten in de wachtrij staan en hoeveel mislukten in de laatste 7 dagen, en onder Laatste bezorgingen de details.

  • Testbericht sturen: een testbericht vertrekt binnen een minuut.
  • Mislukte opnieuw versturen: verstuurt de mislukte bezorgingen van de laatste 7 dagen opnieuw.
  • Uitzetten of Aanzetten, en Verwijderen.

Een mislukte bezorging wordt ongeveer 28 uur lang opnieuw geprobeerd. Antwoordt uw adres meer dan 24 uur niet, dan zet INTEGALL de webhook automatisch uit, met de reden. U kunt hoogstens 10 webhooks hebben.

InstellingenAPI-sleutels toont de NAV-sleutels: sleutels voor externe systemen (ERP, TMS) die routes of adressen opvragen bij de INTEGALL NAV-server. De kantoor- en chauffeursapp hebben geen sleutel nodig; zij gebruiken de eigen aanmelding.

Bevoegdheden: Routes berekenen, Adressen zoeken, Kaarttegels en Voertuigprofiel overschrijven. Ook hier wordt de sleutel maar één keer getoond en vraagt aanmaken een verse code.