SOAP Webservice API
SOAP API
SOAP is een koppeling, waarin je strak vastlegt hoe je koppeling eruit ziet. Dit gebeurt in een XML-format. Dat geeft structuur en controle. Nadeel hiervan is dat de koppeling zwaarder is dan REST koppeling. Je stelt een soort contract op over hoe de koppeling gebruikt moet worden.
Dit ‘contract’ wordt gelegd door connectie te maken middels een WDSL, te weten: https://login.myclang.com/app/api/soap/public/index.php?wsdl&version=1.25&type=literal
Als je een SOAP koppeling wilt uitlezen dan kan dat technisch gezien best een uitdaging zijn. Gelukkig zijn er wel veel goede tools zoals SOAPUI, wat een zeer fijne hulptool is.
De meest gebruikte functie is campaign_execute/campaign_executeAsync. Hiermee stuur je naar een start on event binnen een campagne je ingeschoten data. Nadat de campagne is doorlopen zal er bij gebruik van een " campaign_execute" naar de API een succes of fail response worden gestuurd.
De SOAP API is voornamelijk gericht op 1 op 1 communicatie, in tegenstelling tot de Deployteq webhooks.
Met de Deployteq SOAP API kun je de volgende koppelingen leggen:
Aanmaken, ophalen, wijzigen en verwijderen van klantdata
Aanmaken, ophalen, wijzigen, verwijderen en versturen van van e-mails
Starten van Deployteq Campagnes, waarin data uit SOAP API call beschikbaar is
Ophalen van Reports data
DataModeler Rest API
REST API
Een REST koppeling is een stuk lichter, omdat je daar geen ‘contract’ voor gebruikt. De REST API maakt gebruik van het JSON-format.
REST is makkelijker ontwikkelen, alleen is er (ten opzichte van SOAP) geen bibliotheek beschikbaar. Dit wordt wel steeds meer het geval door het gebruik van een swagger definitie.
Een fijne hulptool voor REST is Postman.
Websites als https://webhook.site kunnen worden gebruik als Test, om verzoeken op te vangen en de inhoud te bekijken.
Binnen Deployteq kan de REST API momenteel gebruikt worden om het Datamodel en Webhooks aan te spreken. Tevens zijn we druk bezig om de REST API's uit te breiden, zie bijvoorbeeld: