Het is mogelijk om bijna elke 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.
| Info |
|---|
Het tabblad Token verzoek (2) komt pas beschikbaar wanneer het veld ‘Toegangstoken benodigd’ aangevinkt is. |
Applicatie toevoegen of bewerken
Het eerste tabblad (Applicatie toevoegen of bewerken (1)) bevat de algemene informatie van de applicatie. Zo kan je hier naam en omschrijving invullen, maar ook de basis URL met bijbehorende onderdelen.
Wanneer er een toegangstoken benodigd is voor de bron dient het veld ‘Toegangstoken benodigd’ aangevinkt te worden. Hierin kan je opgeven of het een onbeperkte token is (statische username en wachtwoord) of dat het een dynamische token is (waarbij bijvoorbeeld een token request gedaan wordt en deze elk uur verloopt). Wanneer het veld voor de toegangstoken aangevinkt is verschijnt bovenin een extra tab ‘Token verzoek’.
| 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.
...
Wanneer het request is uitgevoerd krijg je de body terug, hierin zit waarschijnlijk een onderdeel dat je als token wil 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 tussen dubbele accolades ({{}}) te zetten.
Een voorbeeld hiervan:
...
De header die je hier hebt toegevoegd zal standaard aan elk request van dit type applicatie toegevoegd worden.
Metadata verzoek
Binnen een API applicatie heb je ook de mogelijkheid om metadata vast te leggen. Dit heeft als grote voordeel dat binnen de U-Turn met deze metadata een aantal zaken voor je op de achtergrond geregeld kunnen worden, denk aan bijvoorbeeld de hele lijst met endpoints die een bepaalde API bevat.
...
Ga na of de applicatie die je toe wil voegen een metadata endpoint heeft of niet. Wanneer deze beschikbaar is kan je deze hier opgeven.
Vul het type metadata (OAS, ODATA of SOAP) in, gevolgd door de versie, methode en URL. Wanneer de metadata geldig is wordt deze opgehaald en omgezet in een resultaat met hierin alle endpoints die vastliggen in de betreffende API.
...
Wanneer de metadata correct is vastgelegd zal het ophalen en versturen van data in een U-Turn Studio koppeling vergemakkelijkt worden, aangezien je dan een lijst te zien krijgt met alle endpoints en beschikbare velden die in de metadata vastgelegd zijn.