Van Dooren Transport biedt software leveranciers in de keten de mogelijkheid om een koppeling te maken zodat transportopdrachten geautomatiseerd kunnen worden ingeschoten.
<aside> 🚧 In november 2023 is de eerste versie van deze API opgeleverd en bevind zich nog in de proeffase. Op basis van feedback zal de API nog worden verbeterd en wordt de documentatie bijgewerkt.
</aside>
De aangeboden API maakt het mogelijk om transportopdracht in te schieten in ons Transport Management Systeem (Transpas). Omdat de verwerking asynchroon verloopt is het belangrijk om te weten dat er eerst een ConceptTransportOrder wordt ingeschoten die vervolgens wordt ingelezen in het TMS. Na het inlezen wordt de ConceptTransportOrder verreikt met de werkelijke TransportOrder.
De (technische) documentatie wordt aangeboden in het Swagger 3.0 formaat met daarnaast Swagger UI waarmee de API-calls in de browser getest kunnen worden.
| Omgeving | Endpoint | Documentatie | Rate limit |
|---|---|---|---|
| Productie | https://test.partners.vandooren.nl | https://partners.vandooren.nl/api/doc | 60 API-calls per minuut |
| Test | https://test.partners.vandooren.nl | https://test.partners.vandooren.nl/api/doc | 60 API-calls per minuut |
<aside> ⚠️ De testomgeving is functioneel en kan zonder beperkingen worden gebruikt. Een ontvangen order wordt binnen een minuut geaccepteerd door het systeem. Omdat de order niet wordt verwerkt in het TMS ontbreken er ID’s in de response.
</aside>
Om gebruikt te kunnen maken van de koppeling moet je als partner geautoriseerd zijn. De autorisatie gebeurd middels een apiKey die in de header van elk request meegestuurd wordt.
Authorization: Bearer [apiKey]
Een apiKey kan aangevraagd worden bij Alex van Dooren via deze [link](mailto:[email protected]?subject=Partner%20key%20aanvragen).
In Swagger UI kan de apiKey ingesteld worden door rechts bovenin op “Authorize” te klikken. Vul de apiKey in met het volgende formaat: Bearer [apiKey] (zonder blokhaken). Via de “Try it now” knop aan de rechterkant kan een request worden opgebouwd en uitgevoerd.
Onderstaand meer uitleg over de terminologie en data zoals deze voor de Partner API worden gehanteerd.
| Term | Uitleg |
|---|---|
| ConceptTransportOrder | Een voorlopige order die bekend is in de Partner API maar pas later wordt verwerkt in het Transport Management Systeem |
| TransportOrder | Dit is de transportopdracht in het Transport Management Systeem die ontstaat nadat de ConceptTransportOrder is verwerkt. |
| Datetime objecten | Alle datetime objecten zijn in ISO-8601 met tijdzone, dus als 2020-12-09T16:09:53+00:00. |