Hoe vind je het juiste endpoint van een dienst?

Het juiste endpoint vind je in de documentatie van de aanbieder. Zoek op zijn site naar developers, API of documentatie.

Daar staan de adressen, de velden die je mee moet sturen en meestal voorbeelden die je direct kunt uitproberen.

Is die documentatie er niet, dan is dat op zichzelf een waarschuwing.

Zo herken je het juiste endpoint

Het basisadres, de lijst met endpoints, en per endpoint welk werkwoord erbij hoort en welke velden verplicht zijn.

Ook: hoe je je toegang aantoont, en hoeveel verzoeken je per minuut mag doen. Meer daarover lees je bij api.

De testomgeving

Goede aanbieders hebben een aparte omgeving waar je kunt proberen zonder echte gevolgen. Gebruik die altijd eerst.

Bij een betaalprovider is dat het verschil tussen testen en echt geld overmaken.

Als de documentatie ontbreekt

Vraag ernaar bij de leverancier. Krijg je niets, reken dan op meer werk en meer onzekerheid.

Een koppeling met een dienst zonder documentatie is een risico dat je vooraf in je begroting hoort te zien. Meer daarover lees je bij backend.

Mijn vuistregels

1. Zoek de documentatie voordat je een koppeling toezegt.
2. Kijk of er een testomgeving is.
3. Let op de limieten per minuut; die bepalen je opzet.
4. Bewaar het versienummer van de interface die je gebruikt.

Die laatste voorkomt dat een koppeling stilletjes stopt na een update aan de andere kant.

Wat je aan je bouwer vraagt

Of de dienst een gedocumenteerde interface heeft, of er een testomgeving is, en of hij het juiste endpoint voor jouw doel überhaupt aanbiedt.

Die drie antwoorden bepalen samen of een koppeling een dag of een week kost.

Bij Nederlandse pakketten

De meeste boekhoud- en verzendpakketten hebben goede documentatie. Kleinere branchesystemen vaak niet.

Meer daarover lees je bij wat een endpoint is.

Veelgestelde vragen hierover