De API uitproberen met Try it
Op elke endpoint-pagina staat rechtsboven het codevoorbeeld de knop ‘Try it’. Daarmee kun je de parameters in een formulier invullen en de aanroep vanuit je browser versturen. Het antwoord verschijnt eronder: dezelfde JSON die je in je eigen code zou krijgen.
API-sleutel invullen
Plak bovenin het formulier je API-sleutel in het veld ‘api_key’. Er is geen wachtwoordveld, want de API heeft geen wachtwoord nodig. Waarom dat zo is, lees je bij Authenticatie met je API-sleutel.
Je sleutel blijft in je eigen browser en wordt niet naar de makers van deze site gestuurd. Het verzoek gaat rechtstreeks van jouw browser naar api.laposta.nl, over https.
Let op: het is een echte aanroep
Er is geen aparte testomgeving. Vul je een geldige sleutel in en verstuur je een aanroep die iets aanmaakt, dan wordt dat ook echt aangemaakt in je account.
Gebruik dus geen sleutel van een account met een echt relatiebestand terwijl je aan het uitproberen bent. Let ook op als je op een gedeelde computer werkt: je sleutel blijft in die browser bewaard tot je hem wist.
Vul je helemaal niets in, dan gebeurt er niets ergs. De aanroep wordt zonder sleutel verstuurd en de API antwoordt met een 401, want zonder sleutel weet de API niet om welk account het gaat. Deze foutmelding staat uitgelegd bij Authenticatie met je API-sleutel.
Veilig testen met een aparte lijst
Je kunt veilig testen door een aparte testlijst aan te maken in je account. Maak één lijst aan, noteer het list_id en richt al je proefaanroepen daarop. Je echte lijsten blijven dan onaangeraakt, ook als er iets misgaat.
Een apart gratis testaccount aanmaken is meestal geen optie, zie Eén gratis account per organisatie. Heb je als ontwikkelaar echt een afgeschermde omgeving nodig, neem dan contact op met de helpdesk via helpdesk@laposta.nl. Meerdere betaalde accounts aanmaken kan wel, gebundeld in een beheeromgeving.
Endpoints zonder Try it
Bij een aantal endpoints ontbreekt de knop ‘Try it’ met opzet, omdat die aanroepen niet terug te draaien zijn of vanzelf gaan lopen:
De codevoorbeelden op die pagina’s staan er wel gewoon, zodat je precies ziet hoe de aanroep eruitziet.
Programmeertaal kiezen
Boven het codevoorbeeld kies je de programmeertaal. Op de endpoint-pagina zelf zijn dat er negen, van cURL en PHP tot Python, Go en Swift. In het ‘Try it’-scherm staan er drie (cURL, JavaScript en Python), omdat dat de weergave van je huidige invoer is en niet de volledige lijst.