Open API

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 de authenticatie endpoint wat beschreven staat in het hoofdstuk "Interfaces". Je krijgt dan een Bearer token die je met elk request meestuurt.

Voorbeeld request:
curl --location 'https://services.stasoftware.nl/auth/auth/authenticate' \
--header 'CompanyCode: TEST' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userName": "api-user@stasoftware.nl",
    "password": "je-wachtwoord"
}'

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

Kom je er nog steeds niet uit?

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