Postman
Postman is een applicatie waarmee je makkelijk http requests kan versturen en organiseren.
Op deze pagina leggen we uit:
- waar je Postman kan downloaden.
- hoe je een standaard http request kan versturen.
- hoe je de metadata kan opvragen.
Waar kan ik Postman downloaden?
De Postman API client (desktop applicatie) is te downloaden op https://www.postman.com/downloads/
NOTE: Het pakket valt buiten de verantwoordelijkheid van Horlings & Eerbeek.
Hoe verstuur ik een standaard http request?
Klik linksboven op 'New' en kies 'HTTP Request'. Vul het URL veld in. De meeste request headers zullen
automatisch worden aangevuld door Postman zelf. Kies het soort request dat je wilt maken.
Je hebt 4 standaard types Web Requests:
GET - deze gebruik je alleen om data op te halen. Je kan met een GET nooit data muteren.
POST - deze gebruik je voor:
- het aanmaken van nieuwe data, bijvoorbeeld een nieuwe toewijzing.
- het uivoeren van acties die data kunnen muteren, bijvoorbeeld archiveren of factureren.
DELETE - deze gebruik je om data te verwijderen.
Voor het versturen van een http request dienen eerst nog de OAuth 3.0 authorisatie gegevens ingevuld te worden zodat
de
gebruiker geverifieerd kan worden.
Hoe vul ik de OAuth 3.0 authorisatie gegevens in?
- Navigeer (net onder) de URL balk naar 'Authorization'
- Selecteer in het 'Type' veld de optie 'OAuth 2.0'
- Selecteer in het 'Add auth data to' veld de optie 'Request Headers'
- Scroll naar beneden naar de sectie 'Configure New Token'
- Geef de token een naam (vul 'Token name' in)
- Kies in het 'Grant Type' veld de optie 'Client Credentials'
- Access Token URL: de Url van de 'authority server' + /connect/token
(bijv https://oauth2.dev.hene.nl/connect/token, waar 'oauth2.dev.hene.nl' de authority server is)
- Client Id: Vul hier de Client Id in
- Client Secret: OAuth Client Secret
- Scope
- Selecteer in het 'Client Authentication' veld de optie 'Send client credentials in body'
- Druk op de 'Get New Access Token' knop een token op te halen
Hoe kan ik de 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.