Skip to content
In samenwerking met onderdeel van

Order API Documentatie

De IB ORDER JSON REST API stelt u in staat om uw eigen software op een IB website aan te sluiten en zo eenvoudig vanuit uw eigen systeem bestellingen op te halen, aan te maken, te wijzigen of te verwijderen. U hoeft niet meer continu uw mailbox in de gaten te houden voor nieuwe bestellingen en uw klanten zijn altijd op de hoogte van de huidige status van hun bestelling. Het handmatig invoeren van bestellingen behoort nu tot het verleden.

Benieuwd naar de mogelijkheden voor uw bedrijf? Neem contact op!

Data formaat

Het ontwikkelen en testen van applicaties die van de API gebruik maken is erg eenvoudig. U kunt uw eigen browser gebruiken om de adressen te benaderen en vrijwel iedere HTTP client in welke programmeertaal dan ook kan met de API communiceren. De webservice betreft een JSON API wat inhoud dat zowel de door de webservice verzonden gegevens als de naar de webservice te versturen gegevens (in de request body) aan het JSON-formaat moeten voldoen. Zie http://json.org/ voor meer informatie over dit formaat. Een JSON-string is zowel voor mens als machine makkelijk leesbaar en met een tool als JsonLint op validiteit te controleren.

IB ontwikkelt continu aan zijn diensten en kan daarom niet uitsluiten dat we in de toekomst meerdere formaten gaan aanbieden. Het is daarom aan te raden om al uw requests van een Content-Type header te voorzien zodat wij ook in de toekomst weten in welk data formaat we met uw software dienen te communiceren:

Content-Type: application/json

Basis URL

URLs die in deze documentatie genoemd worden zijn relatief ten opzichte van de volgende basis-URL:

https://www.ib.nl/api/order/v1

Authenticatie

Onze API is enkel over HTTPS te benaderen. IB zet zich in om uw data en privacy zo optimaal mogelijk te beschermen en biedt daarom geen diensten over het onversleutelde HTTP-protocol aan.

Meer informatie? De volledige documentatie betreffende authenticatie tegen de IB API verschijnt als u ingelogd bent.

Inloggen

Endpoints

De IB API beschikt over de volgende functionaliteiten:

Foutmeldingen

Bij eventuele foutmeldingen wordt er door de API ook een JSON response gegenereerd. Deze bevat 2 velden code en message. Hierdoor kunt u deze meldingen ook in uw programmatuur afvangen. Daarnaast geven we middels een HTTP response code aan wat de status van een response is. Hier ziet u een overzicht van alle mogelijke response codes die u kunt tegenkomen bij gebruik van de API.

Code Omschrijving
200 De aanvraag is succesvol behandeld. De response body bevat het resultaat.
301 U wordt omgeleid naar een andere URL. Dit kan voorkomen indien u een placeholder leeg laat.
400 U heeft een ongeldige aanroep verstuurd. Controleer het formaat van eventuele parameters.
401 U heeft zich niet juist geauthenticeerd of u gebruikt een invalide API key.
403 U heeft geen toegang tot de opgevraagde gegevens.
404 De specifieke resource of een onderliggende resource kon niet worden gevonden.

Datatypes

In de documentatie kan naar de onderstaande datatypen gerefereerd worden. Indien er aanvullende restricties van toepassing zijn worden deze middels een reguliere expressie (of in geval van getallen een range) aangegeven.

Type Omschrijving
int 32-bits positief geheel getal
long 64-bits positief geheel getal
decimal Decimaal getal. Afhankelijk van het veld kan de plek van afronding verschillen.
string UTF-8 gecodeerde tekst die in JSON tussen dubbele quotes wordt weergegeven.
datum Datums worden door de API volgens het ISO 8601 formaat opgemaakt, inclusief uren, minuten, seconden en tijdzone aanduiding. Bijvoorbeeld 2019-06-17T22:58:59+02:00.
array Een JSON-array van (in de meeste gevallen) JSON objecten. De structuur van het JSON object wordt altijd apart omschreven.
bool Een boolean JSON waarde. true of false. In geval van invoer worden ook de waarden 0 en 1 geaccepteerd.
url Een string welke een absolute URL bevat. Tenzij anders aangegeven zal dit een URL voor het http- of https-protocol betreffen.

Tips & trucjes

  • Webservice uitproberen? Met de REST Console Chrome extensie is dat heel eenvoudig.