Externe API

Frequentie gebruik: 
Moeilijkheidsgraad: 

De “Externe API” wordt gebruikt om een andere API (Webservice) aan te roepen. Je kunt dit bijvoorbeeld gebruiken voor het ophalen van een “wisselkoers” of het genereren van een willekeurige naam.

Er zijn slechts een paar velden nodig om de Externe API actie te laten werken.

• URL: De domeinnaam zonder https:// ervoor
• Method: Selecteer de methode voor de API.
• Query: De Query (variabelen) die je meestuurt
• Headers: Indien nodig de HTTP headers
• Body: Het bericht zelf
• Output veldnaam: Hier komt de response van de API

Geavanceerd:

• x-www-form-urlencoded: Indien de response in de URL zit (zeldzaam)
• Response Type: Haal je een bestand op? Dan wil je mogelijk arraybuffer of blob kiezen. In 99% van de gevallen wil je de leeg laten.
• Bestand te versturen: Indien de ontvangende partij een bijlage in Byte-Array wil ontvangen vul je hier het bestand dat eerder is gegenereerd is in. We sturen dan een Byte-array naar de gekozen URL. Er wordt geen body meegestuurd.
• Certificaat: ten behoeve van Mutal TLS
• Certificaat Key: ten behoeve van Mutal TLS
• Certificaat CA Chain: ten behoeve van Mutal TLS
• Veld als waarde: Indien je body volledig in één veld staat (bijvoorbeeld bij XML endpoints) kun je kiezen om de veld te koppelen waar de volledige body in staat.
• Uitvoeren in testmode: Wanneer deze aanstaat wordt deze actie ook uitgevoerd in de testmode. Handig voor inlogacties.

Voorbeeld:

Output voorbeeld:

Tip: Moet je een token meesturen in de headers of query?
Dan kun je ook tokens gebruiken uit de kluis. Dit doe je middels ${tokennaam}

voorbeeld:

{
  "Authorization": "Bearer ${my_api_token}"
}

URL Parameters vs Query

Sommige API’s werken met een URL waarbij de parameters direct in de URL worden ingegeven. Dit kan ook 1 op 1 in flow worden ingevoerd. Bijvoorbeeld:

data.fixer.io/api/latest?access_key=SECRETKEY&format=1

Beter is echter om de URL leesbaar te houden en de variabelen in de Query te plaatsen.

Voorbeeld:

URL: data.fixer.io/api/latest
Query:
{
  "access_key": "SECRETKEY",
  "format": "1"
}

MTLS

De meeste API’s communiceren over een normale TLS verbinding (HTTPS). In sommige gevallen wil je echter een Mutal TLS communicatie opzetten. Bij MTLS moet niet alleen de server zich identificeren, maar ook de client. Dus, zowel de server als de client hebben elk hun eigen certificaat. Wanneer ze verbinding maken.
1. Server controleert client: De server vraagt de client om een certificaat en controleert of dit geldig en vertrouwd is.
2. Client controleert server: Tegelijkertijd controleert de client ook het certificaat van de server, net zoals bij standaard TLS.
Dit is bijvoorbeeld nodig bij een koppeling met ONS Nedap met AFAS.

Om dit in te stellen maak je in de token store het certificaat eerst aan. Deze kun je vervolgens selecteren in de Flow.
Certificaat: Het certificaat:
Key: De key
CA Chain: Certificate Authority chain

Veelgebruikte API’s

Google Maps API : berekenen afstanden
Fixer.io : ophalen wisselkoersen
randomuser.me : anonimiseren van personen
https://opendata.rdw.nl/resource/8ys7-d773.json : RDW auto informatie