API handleiding

Lees hier hoe je je authenticeert om gebruik te maken van de API.

Om gebruik te maken van de API moet je je eerst authenticeren. Dit doe je door gebruik te maken van het Token-endpoint. Je hebt hiervoor een apiKey en bedrijfscode nodig. Bij de bedrijfscode gebruik je alleen het lettergedeelte.

Uitleg

Hoofdstukken

Voorbeeld request

Dit voorbeeld request maakt gebruik van curl.


Als je het request hebt uitgevoerd krijg je een tokenType en een accessToken.
Deze twee waardes gebruik je om de andere endpoints van de API aan te roepen.

Swagger UI

Voor de API maken wij gebruik van Swagger. Ga naar https://services.stasoftware.nl/swagger om Swagger te openen. In Swagger UI zit een "Authorize" optie die bovenaan de pagina zichtbaar is.

De "Authorize" optie kun je gebruiken om de andere endpoints te testen in Swagger UI. Vul daarvoor in het "Value" veld eerste de waarde van de tokenType in, gevolgd door een spatie en daarna de accessToken. Zie onderstaand voorbeeld:

Klik vervolgens op de groene knop "Authorize" en je kun de andere endpoints in de Swagger UI gebruiken.

OData

In versie 2.0 van de API maken we gebruik van OData. Hiermee kun je gemakkelijk de gegevens selecteren, filteren en sorteren. Om een overzicht te krijgen van welke opties mogelijk zijn, bekijk de volgende link: https://docs.microsoft.com/en-us/odata/concepts/queryoptions-overview

Kom je er nog steeds niet uit?

Klik dan op de chat knop rechtsonder om een STA Support medewerker te spreken.

Heb je het antwoord gevonden?