GetHttpRequest (= API-request naar een andere applicatie)

Het is ook mogelijk om een externe service aan te roepen door middel van een HTTP request. Selecteer hiervoor de optie GetHttpRequest in het linker paneel van de tab 'Verzamelen'.

Klik op de button ‘Toevoegen’ wanneer alle benodigde informatie voor het request in de volgende blokken ingevoerd zijn:

Algemeen

Voer hier als eerste een naam voor het request in waaruit duidelijk wordt welke data er opgehaald wordt. Vervolgens kun je aangeven of je gebruik wilt maken van een Basis request dat je in de huidige omgeving gedefinieerd hebt. Daarna dient nog de methode voor het request geselecteerd te worden (bijvoorbeeld GET, POST of PUT) en de te gebruiken URL dien ingegeven te worden.

Indien je gebruik maakt van een Basis request zal de Basis URL die daarbij hoort weergegeven worden. Deze zal als prefix aan de opgegeven URL gekoppeld worden.

Certificate

In sommige gevallen eisen externe applicaties dat er een certificaat gebruikt wordt bij het aanroepen van de API. In dit blok kun je de certificaat parameter selecteren die je eerder bij de tab Parametersgedefinieerd hebt.

Overige aanvraag

In dit blok kan overige informatie (Headers en Body) die nodig is om het API-request uit te voeren opgegeven worden.

Indien je gebruik maakt van een Basis request zullen de headers (inclusief eventueel authenticatie token) ook weergegeven worden.

Iedere Iteratie/Loop

Sommige APis geven niet direct alle data terug. Hiervoor zijn dan meerdere aanvragen nodig. Voorbeelden hoe dit toegpast kan worden staan beschreven in Bron data in segmenten ophalen.

Resultaat

In dit blok kan informatie m.b.t. het resultaat aangegeven worden.

Afhankelijk van de gekozen optie bij ResultType (JSON of SOAP/XML) worden er specifieke aanvullende velden getoond.

Indien het resulttype JSON is worden de volgende velden getoond:

• JSON uitklappen tot nivo
  Indien het resultaat een geneste JSON is kun je hier aangeven tot welk nivo de JSON uitgeklapt moet worden. Overige (diepere) nivo’s zullen als JSON string getoond worden.

• JSON selecteer path

Dit zorgt er voor dat slechts een deel van de JSON uitgelezen wordt. Stel je voor dat he van de externe service de volgende JSON terug krijgt

{
  'Stores': [
    'Lambton Quay',
    'Willis Street'
  ],
  'Manufacturers': [
    {
      'Name': 'Acme Co',
      'Products': [
        {
          'Name': 'Anvil',
          'Price': 50
        }
      ]
    },
    {
      'Name': 'Contoso',
      'Products': [
        {
          'Name': 'Elbow Grease',
          'Price': 99.95
        },
        {
          'Name': 'Headlight Fluid',
          'Price': 4
        }
      ]
    }
  ]
}

Ophalen alleen de Manufacturers, gebruik dan als JSON selecteer path:

Manufacturers

Meer informatie kan gevonden worden op kan online gezocht worden op “JSONPath”.

• JSON Schema
  Het kan voorkomen dat de JSON structuur die door de API aangeleverd wordt niet altijd dezelfde structuur heeft doordat in de andere applicatie niet alle informatie aanwezig is. Door een JSON schema te gebruiken kun je aangeven welke velden verwacht worden, zodat je die (ook als ze niet aangeleverd zijn) toch tot je beschikking hebt in de koppeling. Je kunt zelf een schema genereren online door een tool op te zoeken die dit doet (zoek online op “json to schema“).
  

Wanneer het resulttype SOAP/XML is worden de volgende velden getoond:

• XML Selecteer path
  Het kan zijn dat je niet het volledige SOAP/XML resultaat als bron wilt gebruiken. In dat geval kun je hier het path opgeven vanaf waar je het wilt gebruiken. Dit kan iets zijn als “books” bijvoorbeeld.

• XML verwijder onderdeel
  Indien er in het resultaat dat je als bron wilt gebruiken toch nog een onderdeel zit dat je eruit gefilterd wilt hebben kun je hier het path opgeven dat je verwijderd wilt hebben. Dit kan iets zijn als “books” bijvoorbeeld.

Voor elk ResultType (JSON of SOAP/XML) worden de volgende velden getoond:

• Geef leeg resultaat bij foutief request
  Sommige API’s geven als er geen resultaat is een andere response waardoor het ophalen van de bron data faalt. Door deze checkbox aan te zetten zal er in dat soort situaties een lege dataset teruggegeven worden.