Controleren van een api met postman
Postman is een programma waarmee makkelijk http requests kunnen worden verstuurd. Op deze pagina leggen we uit hoe een api getest kan worden met behulp van Postman.
Het pakket valt buiten de verantwoordelijkheid van Horlings & Eerbeek en kan worden gedownload worden op https://www.postman.com.
OData api aanroepen
>Metadata opvragen
Voor het opvragen van de metadata van de OData Api, dient de volgende url gebruikt te worden: https://aeolus.hene.nl/odata/
Uiteraard dient de url aangepast te worden met de juiste basisurl. Indien deze niet bekend is, kun je die op vragen bij je applicatiebeheerder.
De metadata van de OData api is vrijelijk beschikbaar. Indien een gebruiker gegevens wilt opvragen dan dient een gebruiker meegegeven te worden.
Uit de metadata kan de rest van de mogelijke calls worden achterhaald.
>Gegevens opvragen
Voor het opvragen van de gegevens moet eerst een token opgevraagd worden bij de OAuth service.
- Ga in Postman naar de 'Autorization' tab.
- Type: Kies OAuth 2.0.
- Ga rechts naar Configure New Token
- Token name: Geef hier een naam in of laat leeg
- Grant Type: Selecteer Password credentials
- Access Token URL: Geef hier 'https://oauth2.hene.nl/connect/token' de volgende gegevens in:
-
Client IDGeef hier de id in van de client die gebruikt wordt, deze is door Horlings & Eerbeek verstrekt.
-
Client SecretGeef hier de client secret in, die door Horlings & Eerbeek is verstrekt.
-
UsernameJe gebruikersnaam van de api.
-
PasswordJe wachtwoord van de api.
-
ScopeGeef hier 'Aeolus.overzichten.odata.api' in.
-
Client Authenticationselecteer 'Send as Basic Auth header.
- Klik op 'Get New Access Token'
Indien alles goed is verlopen, wordt een token getoond en kan op 'use token' worden geklikt.
De token zal nu met de call meegaan en het resultaat zal in json worden getoond.
De url https://aeolus.hene.nl/odata/