Het is mogelijk om bijna elke een HTTP bron als applicatie toe te voegen. Als je een HTTP applicatie toe wil voegen die nog niet voorgedefinieerd is (Nedap ONS, Mailchimp of Microsoft Graph) dan kan je deze volledig zelf definiëren. Kies bij het type applicatie voor ‘API’ om te beginnen met samenstellen.
...
Een API applicatie kent vier verschillende onderdelen, deze zijn te vinden in de tabbladen bovenaan de pagina.
Applicatie toevoegen of bewerken
Token request
Metadata verzoek
Variabelen
Info |
---|
Het tabblad ‘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 basisinformatie van de applicatie. Hier kun je de naam, omschrijving en basis-URL met bijbehorende onderdelen invullen. Als er een toegangstoken vereist is voor de bron, moet het veld 'Toegangstoken benodigd' worden aangevinkt. Je kunt aangeven of het een onbeperkt token is (met een statische gebruikersnaam en wachtwoord) of een dynamisch token dat bijvoorbeeld elk uur verloopt. Als het veld voor het toegangstoken is aangevinkt, verschijnt er een extra tabblad genaamd 'Token verzoek' bovenaan.
...
...
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.
...
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.
Als er een toegangstoken vereist is voor de bron, moet het veld 'Toegangstoken benodigd' worden aangevinkt. Je kunt aangeven of het een onbeperkte token statische token is, een onbeperkte dynamische token of een dynamisch token dat bijvoorbeeld elk uur verloopt. Als het veld voor het toegangstoken is aangevinkt, verschijnt er een extra 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. |
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.
...