Alle categorieën

Starten met Ternair

Introductie Menu

Home Selecties (klassiek) Doelgroep Manager Campagne Manager Runs Schedules Monitor Campagne groepen

Werking Campaign

Doelgroep Manager (data)

Selecteren & Segmenteren Combineren & Uitsluiten Verrijken & Bewerken

Campagne Manager (kanalen & content)

Kanalen

E-mail

Content

Sleutelpad Automatiseren Uitvoeren Schedule Webhook Tijdzones Rapportages E-mail dashboard Campagnekalender E-mail conversie dashboard Beheer

Algemene instellingen Beheerdersinstellingen

Toegang & Rechten Email Web Integratie AI Assistent Webhooks Webservice Datamarts Systeem Leads Ezines

Processen

Webservice

Met het ‘webservice’ blok kan een connectie naar een externe webservice worden gecreëerd.

In de algemene instellingen kunnen webservices worden gedefinieerd.

Let op: het webservice blok is alleen beschikbaar nadat een webservice is geconfigureerd in de algemene instellingen.

Webservice overzicht

Klik op de button ‘Toevoegen’ om een nieuwe webservice toe te voegen. Webservices die al eerder zijn toegevoegd, zijn op dit tabblad zichtbaar. De webservice kan worden aangepast, gedupliceerd en verwijderd door op de drie puntjes te klikken.

Per webservice wordt de volgende informatie getoond:

Naam

Of de webservice getest mag worden:

Testen: toegestaan --> De webservice mag worden gebruikt voor testdoeleinden

Testen: Niet Toegestaan --> De webservice mag niet worden gebruikt voor testdoeleinden

In welke omgeving de webservice gebruikt mag worden:

Campaign -> De webservice is beschikbaar in de Campagne Manager. Testen toegestaan moet hierbij ook geactiveerd zijn.

Doelgroep -> De webservice is beschikbaar in de Doelgroep Manager. Testen toegestaan moet hierbij ook geactiveerd zijn.

Webservice toevoegen

Klik op + Toevoegen rechtsboven om een bestaande webservice toe te voegen of een nieuwe webservice aan te maken.

Via de zoekbalk kun je controleren of de webservice al beschikbaar is, of je kunt filteren op categorie.

Als je een nieuwe webservice wilt aanmaken, klik je op de button toevoegen.

NL---Webservice---Toevoegen-nieuwe-webservice-button.png

Instellingen

In het Instellingen tabblad stel je de basisinformatie van de webservice in.

Iconen	Onderdeel	Functie
	Naam	Geef de webservice een herkenbare naam.
	URL	Vul de endpoint URL in van de externe webservice.
	Icoon	Pas het icoon aan via Afbeelding Aanpassen
	Methode	Kies de HTTPS methode: Get, Post, Put of Delete
	Authenticatie Type	Kies een authenticatietype: None, Basic, OAuth, HMAC

Daarnaast stel je via de volgende schakelaars in hoe de webservice wordt gebruikt:

Iconen	Onderdeel	Functie
	Testen Toestaan	Sta toe dat de webservice wordt getest
	Verstuur meerdere rijen per aanroep	Verstuur meerdere records in één API-aanroep. Let op: om meerdere rijen per aanroep te versturen, moet de ontvangende webservice hierop zijn ingericht. Je kunt de door de webservice verwachte body samenstellen op het tabblad body.
	Gebruiken in Campagne Manager	Maak de webservice beschikbaar in de Campagne Manager
	Gebruiken in Doelgroep Manager	Maak de webservice beschikbaar in de Doelgroep Manager

Body

In het Body tabblad stel je de inhoud in van de API-aanroep.

Iconen

Onderdeel

Functie

Content Type

Kies het formaat van de body

Body

Vul de body van de aanroep in

Headers

In het Headers tabblad voeg je HTTP headers toe aan de aanroep.

Iconen	Onderdeel	Functie
	+ Voeg header toe	Voeg een extra header toe
	Sleutel	Geef de sleutel een naam
	Waarde	Geef de nieuwe header een waarde (b.v. authenticatie token/API-key of content-type)
	Type	Kies een type, bijvoorbeeld Text
	Verwijder Header	Verwijder een bestaande header

Output

In het Output tabblad stel je in welke data uit de webservice respons wordt opgeslagen.

Iconen	Onderdeel	Functie
	Output Formaat	Kies tussen JSON of XML
	Sleutel in output	Geef aan of de sleutel moet worden meegenomen in de output. Kies de kolomnaam en selecteer de sleutel
	+ Voeg een output toe	Voeg een outputveld toe en geef het veld een naam
	Verwijder Output	Verwijder een bestaand outputveld

Output toevoegen

Kolomnaam	Naam van de kolom in campaign.
JSONPath expressie	De waarde van de kolom in de API respons
Kies sleuteltype	Definieer sleuteltype voor campaign
Verwijder output	Klik op het prullenbak icoon om de output te verwijderen

NL---Webservice---AI---Instellingen---Output---output-mapping-kolomnaam.png

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

In het Geavanceerd tabblad stel je in hoe de webservice omgaat met meerdere resultaten en paginering.

Iconen	Onderdeel	Functie
	Resultaat heeft meerdere rijen	Schakel in als de webservice meerdere rijen retourneert
	Array Expressie	Geef de expressie op waarmee de array wordt geïdentificeerd in de respons
	Heeft Paginering	Schakel in als de webservice gepagineerde resultaten retourneert. Kies daarna tussen: Gebruik paginanummers (stel het begin- en eindpaginanummer in), Gebruik de 'next URL' eigenschap of Stop bij de eerste lege pagina

Sla de configuratie op via:

Optie	Beschrijving
Toepassen	Sla op zonder de editor van de nieuwe gecreëerde webservice te sluiten
Opslaan*	Sla op en sluit de editor
Annuleren	Sluit de editor zonder wijzigingen op te slaan

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

In dit artikel

Webservice Webservice Webservice overzicht Webservice toevoegen Instellingen Body Headers Output Output toevoegen Meerdere sleutels definiëren Geavanceerd Goed om te weten Genereer een unieke waarde