Hulp bij het werken met de REST API

Werk je met Webpower in combinatie met REST API en heb je hier hulp bij nodig? We proberen je het uiteraard zo makkelijk mogelijk te maken.

Zo kun je de REST API scripts bijvoorbeeld testen met Swagger. Om Swagger te kunnen gebruiken, moet de REST API feature zijn geactiveerd. De URL om bij Swagger te komen wordt per klant opgebouwd en bestaat uit:

https://[licentie].webpower.eu/admin/api/swagger

Noot: Ook als je geen gebruik maakt van de REST API kan je de documentaties en voorbeelden zien op Swagger

Je komt nu op Swagger terecht. Bovenstaande afbeelding laat niet alleen gedeeltelijk zien hoe Swagger eruit ziet, maar geeft direct ook aan hoe het werkt. Voordat je met Swagger kunt gaan werken moet eerst worden ingelogd. Dit kan bij ‘’authorize’’. Hier moet je de client_id en de client_secret invullen. Deze kun je in Webpower vinden bij Admin > Rest authorization. Vanaf nu kun je Swagger koppelen met Webpower.

Op Swagger staan allemaal zogenoemde ‘’calls’’ die je via de REST API kunt uitvoeren. De bovenste ‘’call’’ houdt bijvoorbeeld in dat er een lijst van bestaande campagnes wordt teruggegeven. Zoals altijd met coderen, komt het erg nauwkeurig dat alle komma’s en haakjes op de juiste plaats (blijven) staan. Mocht er iets verkeerd staan en voer je de call uit, krijg je een error te zien bij ‘’response’’ die kort uitlegt wat het probleem is. Op deze manier kun je scripts die je wilt laten draaien eerst testen om te zien of het een correcte call is.

Voorbeeld van een REST-call

Om een beeld te geven van hoe een call doen binnen Swagger eruit ziet, geven we je een voorbeeld. In dit geval gaat het om het creëren van een nieuwe campagne. In principe staat de basis voor de call er al, dit wil zeggen: alles vóór de : is al ingevuld. In dit voorbeeld wordt eerst gevraagd om een brand_id, oftewel: onder welk merk moet de campagne geplaatst worden. Om achter dit id te komen kun je in Webpower naar Beheer > Merken. Bij instellingen kies je voor het weergeven van het id.

Vervolgens wordt gevraagd naar de naam van de te creëren campagne en onder welke taal de campagne moet vallen. Geef de taal aan met ‘’nl” als het om Nederlands gaat en bijvoorbeeld ‘’en’’ als het gaat om Engels.

Er volgt nu een aantal vragen dat te maken heeft met de instellingen van de campagne. Zo wordt bijvoorbeeld gevraagd of de campagne moet worden gebruikt op overall niveau, of de campagne ‘’deletable’’ moet zijn en of er alleen vanuit een template gewerkt kan worden.

De volgende vragen hebben betrekking op het versturen van de e-mails zelf. Er wordt bij from_name namelijk gevraagd om de afzendernaam en bij forward_id wordt gevraagd om het id van het forward adres. Dit id kun je vinden in Webpower bij Beheer > Afzenderadressen. Het reply_id is het id van het antwoordadres. Wil je dit niet gebruiken in deze campagne? Geef dan null aan. Ditzelfde geldt voor de sms_from_name (de afzendernaam voor sms-berichten). Mocht je in een campagne conversiepunten willen gebruiken, vul deze dan in onder conversion_points. De has_soap_api mag standaard op true blijven staan en bij blacklist kunnen alle exclude-lijsten worden ingevuld. Dit kan worden ingevuld binnen [   ]. Gebruik een komma om meerdere lijsten in te vullen. Tot slot kan nog worden aangegeven welk local domain gebruikt moet worden in de campagne.