Met onze API's werken

Ik wil gewoon een API gebruiken? Wat wordt er bedoeld met plannen?

Een plan is een verzameling API-resources of subsets van resources uit een of meer API's. Een plan kan een combinatie van bewerkingstypen uit verschillende API's bevatten. Een plan kan een aanroeplimiet hebben die voor alle resources hetzelfde is, maar het is ook mogelijk dat elke resource een eigen aanroeplimiet heeft. Aanroeplimieten geven aan hoeveel aanvragen een toepassing kan uitvoeren gedurende een opgegeven tijdsinterval.

Gebruik deze Developer Portal om de voor u beschikbare plannen door te nemen en het plan te selecteren dat het meest geschikt is voor uw wensen en behoeften. Voor sommige plannen moet u toegang aanvragen omdat er beperkte toegang voor is ingesteld. Wanneer u een aanvraag indient, wordt de organisatie op de hoogte gesteld en beoordeelt de API-beheerder uw aanvraag. Mogelijk wordt er contact met u opgenomen voor meer informatie. Andere plannen zijn zonder voorwaarden beschikbaar.

Hoe bekijk ik mijn gebruik van API's?

Het aantal aanvragen voor verschillende API's die uw toepassing heeft uitgevoerd, wordt afgebeeld op uw toepassingspagina.

Klik op 'Apps' in het hoofdmenu en klik vervolgens op uw toepassing. In de tabel 'Productabonnementen' ziet u alle plannen waarop uw toepassing geabonneerd is.

Voor elke API die is opgenomen in het plan kunt u zien wat het verbruik is ten opzichte van de aanroeplimiet van het plan.

Hoe kan ik een API testen?

Het is mogelijk om een API te testen vanuit deze Developer Portal.

Als u de gegevens van een API bekijkt, ziet u een lijst met de bewerkingen die de API bevat. Hiermee wordt het verb en het pad afgebeeld dat voor de bewerking moet worden gebruikt.

Als u op de bewerking klikt, krijgt u meer informatie, welke parameters ervoor kunnen worden opgegeven, welke resultaten de parameter oplevert, welke mogelijke retourcodes er worden gebruikt en wat de betekenis daarvan is.

Er is ook een knop 'Proberen' voor REST-API's waarmee u de bewerking rechtstreeks vanuit de Developer Portal kunt proberen.

Als de API voor identificatiedoeleinden een client-ID of clientgeheim vereist, kunt u deze legitimatiegegeven voor toepassing boven aan de sectie 'Proberen' opgeven.