Op een HTTP verzoek te doen, zijn verschillende instellingen nodig. Binnen U-Turn Studio gebruiken we dit bijvoorbeeld binnen een applicatie of binnen een koppeling.. Hieronder is uitgelegd hoe dit verzoek werkt.[TODO: GRAAG UITLEG OVER DE WERKING VAN HET HTTP REQUEST COMPONENT (URL, QUERY PARAM, HEADERS, ETC.]
| Info |
|---|
Op sommige plekken komt dit component in een iets andere vorm terug, en missen er bijvoorbeeld bepaalde tabbladen of opties. |
...
Een HTTP verzoek binnen U-Turn Studio bestaat uit een aantal verschillende onderdelen.
De methode voor je HTTP verzoek
URL van het HTTP verzoek
Query parameters
Headers
Body
Gebruikerscertificaat
Onderdelen 3 t/m 6 zijn beschikbaar als tabblad. Door op de naam van het onderdeel te klikken verschijnt de juiste inhoud van het tabblad.
Methode (1)
De methode bepaalt de actie van het HTTP request. Haal je data op? Dan gebruik je in de meeste gevallen GET. Voor het versturen van data wordt meestal PUT, PATCH of DELETE gebruikt. De mogelijkheden voor dit veld zijn GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS en TRACE.
URL (2)
Dit is het adres waar je je HTTP verzoek naartoe gaat sturen. De URL is een waarde of berekening.
Query parameters (3)
Queryparameters in een HTTP-request zijn extra gegevens die worden toegevoegd aan de URL van het verzoek. Ze worden gebruikt om specifieke informatie naar de server te sturen als onderdeel van het verzoek. Deze parameters zijn vaak van invloed op de manier waarop de server de gevraagde gegevens terugstuurt of verwerkt.
Klik op de '+ Query parameter toevoegen' knop om een nieuwe query parameter toe te voegen.
...
Een query parameter bestaat uit een naam en een waarde. De waarde is hier ook weer een waarde of berekening.
Voorbeeld query parameters
Stel, je hebt de volgende URL gevonden in de documentatie van de applicatie waar je iets vandaan wil halen. Hierin is alles achter het vraagteken (?) een query parameter. In dit geval zijn het er twee, en deze zijn gescheiden door een &-teken.
| Code Block |
|---|
https://api.example.com/search?type=question&limit=10&date=2023-08-02 |
Statische query parameters (parameters met een vaste waarde die niet dynamisch zijn) zou je eventueel in de URL kunnen verwerken.
...
Voor dynamische query parameters, bijvoorbeeld om een dynamische datum mee te sturen, kan je het invulformulier voor de query parameters gebruiken.
Hier heb je de mogelijkheid om bijvoorbeeld dynamisch de datum van vandaag te berekenen en deze mee te sturen in je request.
Dat ziet er in het invulformulier als volgt uit:
...
Headers (4)
In dit onderdeel is het mogelijk om headers toe te voegen aan je HTTP request.
| Info |
|---|
Headers in een HTTP-request zijn metagegevens die aan het verzoek worden toegevoegd om extra informatie over het verzoek te verstrekken aan de server of om specifieke acties te specificeren. Deze headers bevatten belangrijke details die helpen bij het identificeren, authenticeren en verwerken van het verzoek door de server. |
...
Klik op de knop ‘+ Header toevoegen’ om een nieuwe header toe te voegen aan je HTTP request. Veelvoorkomende headers zijn bijvoorbeeld ‘Accept', ‘Content-Type’ en 'Authorization’.
HTTP headers bestaan uit een naam en een waarde. De waarde is een waarde of berekening.
...
In bovenstaand voorbeeld zijn twee headers toegevoegd aan het HTTP request.
Body (5)
Een body kan optioneel meegestuurd worden bij een HTTP request.
| Info |
|---|
In een HTTP request is de body het gedeelte van het verzoek dat optioneel gegevens bevat die naar de server worden gestuurd. Dit gedeelte wordt vaak gebruikt bij HTTP-methoden zoals POST, PUT en PATCH, waarbij de client gegevens naar de server wil sturen voor verwerking of bijwerking. De body kan verschillende soorten gegevens bevatten, zoals tekst, JSON, XML of andere bestandsgegevens, afhankelijk van het type toepassing en het doel van het verzoek. |
De body is een waarde of berekening. Hier kan je zelf je body samenstellen.
...
Gebruikerscertificaat (6)
Voor sommige API’s heb je een gebruikerscertificaat nodig voor de authenticatie. Bijvoorbeeld voor het verbinding maken met Nedap ONS heb je een gebruikerscertificaat nodig.
| Info |
|---|
Authenticatie van een API met behulp van een gebruikerscertificaat, ook wel clientcertificaat genoemd, is een methode waarbij de client (bijvoorbeeld een applicatie of een gebruiker) zijn identiteit bewijst aan de server door het presenteren van een digitaal certificaat. Het certificaat bevat de openbare sleutel van de client en wordt gegenereerd en ondertekend door een vertrouwde certificaatautoriteit. |
Binnen een HTTP verzoek in U-Turn Studio kan je deze gemakkelijk meesturen.
...
Met de knop ‘Selecteer bestand’ kan je het certificaat selecteren dat je mee wil sturen. Er opent een file selector waar je het bestand kan selecteren. Hier wordt al gefilterd dat je alleen maar het juiste bestandstype (.pfx) te zien krijgt.
Voer vervolgens bijbehorende wachtwoord in om het certificaat compleet te maken.