INTEGALL pour les développeurs
L'API INTEGALL pour votre ERP, TMS ou WMS : ce qui existe, l'adresse, le premier appel et ce qui n'existe pas (encore).
Avec l'API INTEGALL, une entreprise de transport connecte son propre ERP, TMS ou WMS à INTEGALL. L'API est une API REST en JSON, version v1. Ces pages décrivent uniquement ce qui existe réellement aujourd'hui.
Ce que l'API permet#
| Opération | Méthode et chemin | Autorisation |
|---|---|---|
| Contrôle de santé | GET /v1/ping | aucune clé nécessaire |
| Description technique (OpenAPI 3.1) | GET /v1/openapi.json | aucune clé nécessaire |
| Lister les envois | GET /v1/shipments | shipments:read |
| Un envoi avec sa chronologie | GET /v1/shipments/{ref} | shipments:read |
| Demander un transport | POST /v1/shipment-requests | shipments:write |
| Lister les factures définitives | GET /v1/invoices | invoices:read |
En outre, INTEGALL envoie des webhooks lors de trois événements : le statut d'un envoi change, une facture devient définitive, une facture est payée.
L'adresse#
https://api.integall.com/functions/v1/api-v1Tous les chemins ci-dessus viennent après cette adresse, par exemple https://api.integall.com/functions/v1/api-v1/v1/shipments. L'adresse exacte figure aussi dans le panneau entreprise sous API et webhooks (Adresse de l’API).
En trois étapes#
- Le propriétaire ou un administrateur de l'entreprise de transport crée une clé API dans le panneau entreprise. Voir Clés API et webhooks.
- Vérifiez que l'API est joignable :
curl https://api.integall.com/functions/v1/api-v1/v1/ping- Effectuez un premier appel avec la clé :
curl -H "Authorization: Bearer $INTEGALL_API_KEY" \
"https://api.integall.com/functions/v1/api-v1/v1/shipments?limit=10"Placez la clé dans une variable d'environnement (INTEGALL_API_KEY), jamais dans votre code source.
Règles#
- Utilisez l'API uniquement depuis un serveur. Ne placez jamais une clé dans un navigateur ou une application mobile.
- Chaque clé appartient à une seule entreprise de transport et ne voit que les données de cette entreprise.
- Commencez avec une clé de test (
rr_test_…) : elle lit vos données réelles, mais n'enregistre rien. - Les données d'exemple (marquées comme exemple dans le panneau) n'apparaissent jamais dans l'API.
Ce qui n'existe pas (encore)#
- Pas d'API d'écriture en dehors des demandes : créer ou modifier des trajets ou établir des factures n'est possible que dans le panneau entreprise. Une demande envoyée via l'API arrive sous Demandes et le bureau en fait un trajet.
- Pas de connexion à un eFTI Gate : INTEGALL n'est pas une plateforme eFTI certifiée et n'est pas connecté à l'eFTI Gate d'un État membre. Il n'existe pas d'interface pour les autorités ou les eFTI Gates. Voir eFTI.
- API NAV (prévue) : l'API pour les itinéraires de camions et les adresses est développée, mais le serveur NAV n'est pas encore en service. Voir API NAV.
- Gérer les webhooks via l'API : l'autorisation
webhooks:manageexiste, mais aucun chemin de lav1ne l'utilise. Les webhooks se gèrent dans le panneau entreprise.