...
Een API applicatie kent vier verschillende onderdelen, deze zijn te vinden in de tabbladen bovenaan de pagina.
| Info |
|---|
Het tabblad Token verzoek ‘Token verzoek’ (2) komt pas beschikbaar wanneer het veld ‘Toegangstoken benodigd’ aangevinkt is. |
Applicatie toevoegen of bewerken
Het eerste tabblad (, genaamd "Applicatie toevoegen of bewerken (1)) ", bevat de algemene informatie basisinformatie van de applicatie. Zo kan Hier kun je hier de naam en omschrijving invullen, maar ook de basis , omschrijving en basis-URL met bijbehorende onderdelen invullen.
Wanneer Als er een toegangstoken benodigd vereist is voor de bron dient , moet het veld ‘Toegangstoken benodigd’ aangevinkt te worden. Hierin kan je opgeven 'Toegangstoken benodigd' worden aangevinkt. Je kunt aangeven of het een onbeperkte onbeperkt token is (met een statische username gebruikersnaam en wachtwoord) of dat het een dynamische dynamisch token is (waarbij bijvoorbeeld een token request gedaan wordt en deze dat bijvoorbeeld elk uur verloopt). Wanneer Als het veld voor de het toegangstoken is aangevinkt is , verschijnt bovenin er een extra tab ‘Token verzoek’tabblad genaamd 'Token verzoek' bovenaan.
| Info |
|---|
Heb je een statische token die aan elke call toegevoegd dient te worden, maar nooit verandert? Voeg deze dan toe als header aan de basis URL in plaats van gebruik te maken van een dynamische token. |
Bij het onderdeel ‘Basis verzoek’ dient de basis URL opgegeven te worden. Vaak is dit de URL zonder enige endpoints erachter.
Bijvoorbeeld: Voor de Petstore (een test-API) zijn er twee uit te voeren verzoeken: GET https://petstore.swagger.io/v2/pet/1 en POST https://petstore.swagger.io/v2/store/order. In dit geval is https://petstore.swagger.io/v2 de basis-URL, en alles wat daarachter komt, is een specifiek endpoint. Vul dus https://petstore.swagger.io/v2 in als basis-URL.
Zorg er ook voor dat de andere onderdelen van het basisverzoek hier worden ingevuld. Denk hierbij aan statische toegangstokens, content type of gebruikerscertificaten. Door deze informatie hier vast te leggen, hoef je dit later niet op verschillende plaatsen opnieuw te doen.
Token verzoek
Binnen deze tab kan een toegangstoken worden samengesteld. Roep hiervoor de URL aan voor je token verzoek en voeg alle onderdelen toe die noodzakelijk zijn. Wanneer je dit gedaan hebt kan op de knop ‘Test token verzoek’ geklikt worden, dit zorgt ervoor dat de request uitgevoerd wordt en je met behulp van de response de toegangstoken kan samenstellen.
...
Wanneer Nadat het request verzoek is uitgevoerd krijg je de body terug, hierin zit waarschijnlijk een onderdeel , ontvang je een response-body waarin zich mogelijk een element bevindt dat je als token wil wilt gebruiken. Voeg een header toe met de key en voeg hier een value aan toe uit je body. Verwijs naar de value uit je request door de property een specifieke sleutel en wijs hieraan de waarde toe die je uit de body hebt verkregen. Verwijs naar deze waarde in je verzoek door de eigenschap tussen dubbele accolades ({{}}) te zettenplaatsen.
Een voorbeeld hiervan:
...
De header die je hier hebt toegevoegd zal standaard aan elk request van dit type applicatie toegevoegd worden.
...