Lees hier hoe je gebruik kunt maken van de Open API om zowel gegevens op te halen als aan te voeren.
Authenticeren
Het authenticeren van de Open API werkt middels een Bearer token. Om een token te genereren moet je hiervoor een gebruikers account maken met het de rol API. Vervolgens kun je met deze gebruiker je authenticeren via het authenticatie endpoint wat beschreven staat in het hoofdstuk "Interfaces". Je krijgt dan een Bearer token die je met elk request meestuurt.
Interfaces (endpoints)
Voor de Open API maken wij gebruik van Swagger UI. Klik op deze link https://services.stasoftware.nl/swagger om Swagger UI te openen en te bekijken wat de mogelijkheden zijn.
OData
De Open API maakt 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
Oude API
De oude api met versie 1 en 2 wordt niet meer ondersteund.
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.
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.
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?