Tradeinterop heeft een API die ervoor zorgt dat softwarepakketten op een laagdrempelige en robuuste manier kunnen integreren met het tradeinterop platform. De API functionaliteit is beschikbaar voor klanten van tradeinterop die een 'premium' of 'enterprise' abonnement hebben.
API kenmerken
De API heeft de volgende kenmerken:
- De API is RESTful
- Alle berichten verlopen via HTTPS
- Authenticatie op basis van OAuth2.0 of Basic Authentication
- Interfaces voor het versturen van facturen en het opvragen van de afleverstatus
- Interface voor het ontvangen van facturen
Hoe te beginnen
Om te beginnen met de tradeinterop API zijn de volgende stappen nodig:
- 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.
- Daarna worden de API documentatie en API credentials ter beschikking gesteld.
- Ontwikkel de API calls voor het versturen/ontvangen van een bericht en het opvragen van de status.
- Berichten die u via de API uitwisselt kunnen gevolgd worden 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 Nederlands KvK nummer
- 9944 is de aanduiding voor een Nederlands BTW nummer
- 0190 is de aanduiding voor een Nederlands Organisatie (overheids) Identificatie Nummer (OIN)
- 0208 is de aanduiding voor een Belgisch KBO nummer
- 9925 is de aanduiding voor een Belgisch BTW nummer
'bbbbbbbbbbbb' een identifier is conform het formaat dat is aangegeven in de 'aaaa' type identifier aanduiding, dus bijvoorbeeld:
- KVK/KBO nummer van de ontvanger
- BTW nummer van de ontvanger
- OIN nummer van de ontvanger
Voorbeelden van identifiers zijn:
- 0106:12345678
- 0208:012345678
- 9944:NL123456890B01
- 0190:00000000000123456789
Vragen & contact
Voor vragen kunt u contact opnemen met support@tradeinterop.com