Met het ‘webservice’ blok kan een connectie naar een externe webservice worden gecreëerd.
In de globale instellingen kunnen webservices worden gedefinieerd.
Klik op de button ‘Voeg nieuwe webservice toe’ om een nieuwe webservice toe te voegen. Webservices die al eerder zijn toegevoegd zijn op dit tabblad zichtbaar. De webservice kan worden aangepast en verwijderd door op het tandwielicoon te klikken.
Let op: het webservice blok is alleen beschikbaar nadat een webservice is geconfigureerd in de globale instellingen.
Webservice toevoegen
Instellingen
Vul de instellingen in om een nieuwe webservice toe te voegen.
| Name | Unieke naam van de webservice. |
| URL | De URL voor de webservice. |
| Methode | Selecteer de webservice methode (GET, POST, PUT, DELETE, PATCH of HEAD). |
| Authenticatie type | Specificeer het type authenticatie voor de webservice (geen, basisauthenticatie, Oauth2 of HMAC (Hash based Message Authentication Code)). |
| Testen toestaan (optioneel) | Schakel ‘test’ button in in een webservice blok. Let op: wanneer een POST methode wordt gebruikt wordt de webservice methode uitgevoerd bij een klik op de test-button. |
Aanvullende instellingen van het webservice blok voor Body, Headers, Output en Geavanceerd kunnen via de andere tabbladen worden ingesteld.
Body
Bepaal het content type.
Headers
Voeg headers toe.
Output
Met de instellingen in het output tabblad kies je welke velden opgehaald worden voor selectie en output in campaign.
De mapping voor het webservice blok kan worden ingesteld via het ‘Output’ tab.
In het eerste veld kan je een naam geven.
In het tweede veld, kan je afhankelijk van je output formaat, een XPath of JSON selector invullen.
Output toevoegen
| Kolomnaam | Naam van de kolom in campaign. |
| JSON/ XML path expressie | De waarde van de kolom in de API respons |
| Sleuteltype | Definieer sleuteltype voor campaign |
Let op: rijen uit de API-respons met een kolomlengte van meer dan 999 tekens worden niet in Ternair Campaign verwerkt.
In geval van een JSON selector kan je ook gebruik maken van de volgende syntax: {{ select_json “JSON Path Expression” }}. Deze syntax ondersteunt de Scriban template taal, bijvoorbeeld: {{ select_json “$.name” }}.
Waardes met spaties kunnen met de volgende syntax opgehaald worden: $.[‘waarde met spatie’].
Meerdere sleutels definiëren
Meerdere sleutels kunnen worden gedefinieerd in één webservice. Door te klikken op het sleutelveld kun je een hoofdsleutel aanwijzen.
Let op: Het aanwijzen van een hoofdsleutel is niet noodzakelijk.
Geavanceerd
Met het ‘Geavanceerd’ tabblad kun je kiezen tussen data verrijken of het ophalen van een gehele dataset.
Mocht de webservice respons meerdere records in een responsbody ontvangen, kan je deze uitsplitsen met een array expressie. Je kan het pad van het hoogste element dat een record bevat hier opvoeren. Indien je de root op wil halen, kan je in het geval van Json gebruik maken van $ , voor xml maak je gebruik van “/”.
Indien de webservice meerde “pagina’s” terug moet sturen, kan je van de optie ‘Heeft paginering’ gebruikmaken. Met paginanummer kan je opgeven welke range van pagina’s opgehaald moet worden. Standaard zijn dit 25 pagina’s. Neem contact op met je consultant mocht dit aantal niet voldoende zijn. Paginanummers beginnen vanaf 0. Paginanummers kan je gebruiken in de url of de aangeleverde body door deze {{pagenumber}} te mappen. Indien je de optie ‘Stop bij eerste lege pagina’ aanvinkt, wordt de paginering gestopt bij de eerste lege pagina.
Goed om te weten
Genereer een unieke waarde
Genereer on the fly een guid waarde in je output. Ideaal wanneer je response meerdere rijen bevat die géén unieke waarde bevat.
Gebruik syntax {{ math.uuid }} om het volgende als resultaat te krijgen:
019b3dad-be25-4ce9-bfc5-6c3a956cbc61
027ec66e-8317-45b9-9ddc-89083b89a8df
