Shipment KVK API Interface

Stratech Shipment biedt de mogelijkheid een koppeling te realiseren vanuit het ERP-bedrijfssysteem. Hiermee kan je gegevens vanuit het bedrijfssysteem doorsturen naar Shipment voor het aanmaken en vullen van een aangifte of document. Het is een HTTPS / JSON API gebaseerd op REST principe.

Als je verbinding wilt maken met de Shipment API en deze wilt gebruiken, moet je bekend zijn met het HTTPS-protocol, de JSON gegevensweergave en REST-principes. Minimale vereisten voor de API verbindingen is TLS 1.3. Stratech gebruikt Postman voor interne test doeleinden.  Deze interface is bedoeld voor KVK-exportdocumenten zoals de CVO.

1. Authenticatie

Voor authenticatie van de API verbinding wordt gebruik gemaakt van Basis Authenticatie.
Om de koppeling met Shipment voor exportdocumenten van de KvK te gebruiken, dient er Public API-gebruiker worden aangemaakt in Stratech Shipment.

Voorwaarde

- Je bent ingelogd als administrator in Stratech Shipment

Stappen

1. Ga naar Beheer en klik op Instellingen:
2. Klik op Gebruikers
3. Klik op Toevoegen (groene tegel)
4. Vul de volgende gegevens in:
- Naam
- E-mailadres
- Profiel: kies Public API
5. Klik op Toepassen

De gebruiker ontvangt automatisch een e-mail om een wachtwoord in te stellen
Deze inloggegevens zijn nodig voor de koppeling tussen uw ERP-systeem en de Stratech Shipment API

2. Voorbeelden & Documentatie

3. Gebruiker Configureren

Om te beginnen met het opzetten van de API-verbinding voor de KvK Interface moet er een gebruiker aangemaakt worden binnen de Stratech Shipment omgeving. Deze gebruiker moet het profiel “Public API” krijgen. Voor meer informatie klik hier.

4. API Verbinding

Voor het versturen van JSON bestanden of het aanroepen van de swagger pagina, gebruik deze URL’s :

4.1 Stratech Shipment:

4.2 Beurtvaartadres ShipmentManager:

Hierbij moet {Prefix} vervangen worden door de prefix die wordt gebruikt voor je eigen Stratech Shipment omgeving. De inloggegevens van de “API Gebruiker” en de URL moeten worden ingevuld binnen je eigen ERP zodat er een verbinding opgezet kan worden.