Tradeinterop API: getting started

API kenmerken
– De API heeft de volgende kenmerken:
– De API is RESTful
– Alle berichten verlopen via HTTPS
– Authenticatie op basis van OAuth2.0
– Interfaces voor het versturen van facturen en het opvragen van de afleverstatus
– Binnenkort zal ook de interface voor het ontvangen van facturen worden gepubliceerd

Hoe te beginnen
Om te beginnen met de tradeinterop API zijn de volgende stappen nodig:
1. Een ‘premium’ of ‘enterprise’ abonnement is nodig om te beginnen met de API. Als u nog geen ‘premium’ of ‘enterprise’ abonnement hebt, neem dan contact op met support@tradeinterop.com.
2. Bekijk ter voorbereiding de tradeinterop API specificaties op doc.tradeinterop.com. Op deze pagina staat beschreven hoe u de API calls dient op te bouwen. Ook kunt u via deze pagina testberichten sturen. Vraag hiervoor een tijdelijke API Key aan via support@tradeinterop.com.
3. Ontwikkel de API calls voor het versturen van een bericht en het opvragen van de status. Voor details over deze stap zie doc.tradeinterop.com.
4. Berichten die u via de API verstuurd worden zichtbaar in het tradeinterop portaal.

Identifiers
De API maakt gebruik van PEPPOL identifiers om de verzender en de ontvanger te identificeren. Deze identifiers zijn als volgt opgebouwd:
‘aaaa:bbbbbbbbbbbb’
waarbij:
‘aaaa’ een 4-cijferige code is om het type identifier aan te duiden. Voorbeelden zijn:
– 0106 is de aanduiding voor een KVK nummer
– 9944 is de aanduiding voor een Nederlands BTW nummer
– 9954 is de aanduiding voor een Nederlands overheids identificatie nummer (OIN)

‘bbbbbbbbbbbb’ een identifier is conform het formaat dat is aangegeven in de ‘aaaa’ type identifier aanduiding, dus bijvoorbeeld:
– KVK nummer van de ontvanger
– BTW nummer van de ontvanger
– OIN nummer van de ontvanger

Voorbeelden van identifiers zijn:
– 0106:123456789
– 9944:NL123456890B01
– 9954:00000000012344567889595949

Vragen & contact
Voor vragen kunt u contact opnemen met support@tradeinterop.com.