Shipment Documenten API Interface
Inleiding
Deze pagina omvat informatie om data voor Documenten (o.a. CMR, ATR) te versturen via API. De API voor documenten maakt gebruik van dezelfde authenticatie- en communicatiemethoden als de overige API-koppelingen binnen Stratech Shipment.
Bedrijven die al beschikken over een actieve koppeling kunnen daarom vaak gebruikmaken van bestaande configuraties en toegangsgegevens. Voor het versturen van documentgegevens wordt een specifieke endpoint-URL gebruikt. Zorg ervoor dat de juiste endpoint wordt toegepast voor de betreffende API-aanroep.
Het wordt aanbevolen om alle stappen en vereisten in deze documentatie zorgvuldig te doorlopen voordat de koppeling wordt ingericht of in gebruik wordt genomen.
1. API Settings configureren
In Stratech Shipment dient een ‘Client ID’ en bijbehorend ‘Client Secret’ te worden gegenereerd. Volg onderstaande stappen om deze te genereren:
- Log in op de Stratech Shipment omgeving: https://{Prefix}.stratechshipment.nl/
- De juiste URL heb je van Stratech ontvangen in een activatie e-mail. Deze e-mail is verstuurd naar degene die de Stratech Shipment omgeving heeft aangevraagd.
- Klik op Instellingen
- Klik op Import
- Klik op ‘Genereer’ om het ‘Client ID’ en ‘Client Secret’ te laten genereren: 
Stel de gegenereerde gegevens (client/secret) veilig. Deze zijn achteraf niet meer zichtbaar, dus je kan ze het beste in dit scherm kopiëren en plakken.
Dit kan achteraf niet meer.
2. Endpoint configureren t.b.v. documenten (CMR / ATR)
De URL van de Shipment API wordt beschikbaar zodra de Shipment omgeving ‘geactiveerd’ is. De persoon die Shipment ‘aanvraagt’, ontvangt van Stratech een e-mail met daarin een instructie om de omgeving te activeren. In deze e-mail staat o.a. de basis URL van Shipment, zoals in onderstaand voorbeeld:
De bedrijfsnaam van de aanvrager staat verwerkt in de URL. Dus als voorbeeld, stel dat bedrijf “Jansen Logistiek BV” Shipment aanvraagt, dan zou dit de URL hieronder zijn. Let op dat elk document een eigen endpoint heeft, hieronder in blauw weergegeven.
Productie omgeving:
- GUI: https://JansenLogistiekBV.stratechshipment.nl/
- POST: https://JansenLogistiekBV.stratechshipment.nl/erpservices/Documents/CreateCmrDocument
- POST: https://JansenLogistiekBV.stratechshipment.nl/erpservices/Documents/CreateAtrDocument
- Swagger: https://JansenLogistiekBV.stratechshipment.nl/erpservices/swagger/index.htm
Test omgeving (optioneel):
- GUI: https:// TEST-JansenLogistiekBV.shipment-stratech.nl/
- POST: https:// TEST-JansenLogistiekBV.shipment-stratech.n/erpservices/Documents/CreateCmrDocument
- POST: https:// TEST-JansenLogistiekBV.shipment-stratech.n/erpservices/Documents/CreateAtrDocument
- Swagger: https:// TEST-JansenLogistiekBV.shipment-stratech.nl/erpservices/swagger/index.html
Test omgevingen zijn compleet gescheiden van productie, inclusief adresboek configuratie.
3. Authenticatie
Stratech maakt gebruik van een ‘Bearer token’ voor authenticatie. Om een ‘Bearer token’ op te halen dient een aanroep te worden gemaakt naar een specifieke URL.
- Voor Shipment Test omgevingen : https://shptrainingidentity.stratech.nl/connect/token
- Voor Shipment Productie omgevingen : https://identity.stratech.nl/connect/token
Hieronder een voorbeeld van de cURL settings die Stratech zelf gebruikt vanuit Postman. Indien gebruik wordt gemaakt van andere technologieën, dan dien je zelf deze settings te vertalen richting je eigen programmatuur.
De geldigheidsduur van het ‘Bearer’ token is 1 uur. Om die reden adviseert Stratech om bij elke API aanroep, tevens een nieuw ‘Bearer token’ op te halen om dit proces automatisch te laten verlopen.
4. Documentatie API voorbeeldsets
Via deze URL zijn voorbeeldsets voor het CMR en ATR te downloaden:
- CMR - Documentatie & Download
- ATR - Documentatie & Download