API call

Externe systemen aanroepen vanuit je proces

Wat doet het API call-blok?

Met het API call-blok roep je een extern systeem aan via een HTTP-request.

Dit gebruik je om:

  • gegevens op te halen
  • informatie weg te schrijven
  • een externe actie te starten
  • het proces te verrijken met externe data

Het proces wacht tot de call is afgerond en gaat daarna verder.

Wanneer gebruik je dit blok?

Gebruik het API call-blok wanneer:

  • je data nodig hebt uit een extern systeem
  • je een wijziging wilt doorvoeren buiten Orchestra
  • je proces afhankelijk is van externe informatie

Endpoint en HTTP-methode

Je configureert eerst:

Endpoint URL

Het volledige adres van de API die je wilt aanroepen.

HTTP-methode

GET, POST, PUT, DELETE of PATCH.

In zowel de URL als andere velden kun je tags gebruiken om de call dynamisch te maken.

Invullen van URL en HTTP methode bij een API call in Orchestra

Querystring parameters

Je kunt één of meerdere querystring parameters toevoegen.

  • elke parameter bestaat uit een naam en een waarde
  • waarden mogen tags bevatten
  • parameters worden automatisch aan de URL toegevoegd

Dit is handig voor:

  • filters
  • identificatie
  • eenvoudige configuratie van de call
Query string parameters toevoegen aan een API call in Orchestra

HTTP headers

Via HTTP headers kun je extra informatie meesturen, zoals:

  • authenticatiegegevens
  • content type
  • specifieke API-instellingen

Headers kunnen vaste waarden bevatten of tags gebruiken.

Toevoegen van HTTP headers bij een API blokje in Orchestra

Request body

Bij POST, PUT en PATCH kun je een request body meesturen.

  • formaat: ruwe data
  • inhoud: exact zoals opgegeven
  • geschikt voor JSON, XML of andere payloads

Let op
Op dit moment kunnen nog geen tags worden gebruikt in de body.
Deze mogelijkheid wordt binnenkort toegevoegd.

Verwachte response

Je geeft aan wat je verwacht van de API:

  • verwachte HTTP-statuscode
    Bijvoorbeeld 200–299
  • timeout
    Maximale wachttijd in seconden

Als de API hier niet aan voldoet:

  • wordt dit gemeld in Murphy
  • het proces stopt

Timeout

Maximale wachttijd in seconden voordat de call als mislukt wordt beschouwd.

Resultaat ophalen (optioneel)

Als de API een JSON-response retourneert, kun je een deel van het resultaat ophalen.

  • via een JSONPath
  • voorbeeld: $.data
  • optioneel: geen pad = geen resultaat beschikbaar

Het resultaat kan worden opgeslagen in een variabele en gebruikt voor:

  • gateways
  • e-mails
  • handmatige taken
  • omzettingstabellen

Procesgedrag en foutafhandeling

Belangrijk gedrag van het API call-blok:

  • het proces wacht tot de call is afgerond
  • bij een verwachte statuscode → proces gaat verder
  • bij een onverwachte statuscode →
    • fout wordt vastgelegd in Murphy
    • proces stopt

Dit maakt het API call-blok een kritische technische stap in het proces.