Skip to main content

SOAP API and REST API - Knowledgebase / Documentation - Deployteq Support

SOAP API and REST API

Authors list

Difference between SOAP and REST APIs
Standards in web services come in all shapes and sizes, but today the most commonly used types are, SOAP and REST links.

SOAP API

SOAP is a link, in which you tightly define what your link looks like. This is done in an XML format.  This gives structure and control. The disadvantage is that the coupling is heavier than REST coupling. You draw up a kind of contract about how the link should be used.

  • This "contract is established by making a connection via a WDSL: https://login.mydeployteq.com/app/api/soap/public/index.php?wsdl&version=1.25&type=literal.
  • If you want to read a SOAP link, it can be technically quite a challenge. Fortunately, there are many good tools such as SOAPUI, which is a very fine auxiliary tool.
    The most commonly used function is campaign_execute/campaign_executeAsync.
  •  With this, you send to a start on event within a campaign your entered data. After the campaign has run, if a " campaign_execute" is used, a success or fail response will be sent to the API.
  • The SOAP API is mainly aimed at 1-to-1 communication, unlike the Deployteq webhooks.

REST API

  • A REST link is a lot lighter because you don't use a "contract" for it. The REST API uses the JSON format.
  • REST is easier to develop, but compared to SOAP, there is no library available. However, this is increasingly becoming the case through the use of a swagger definition.
  • A fine auxiliary tool for REST is "Postman".
  • Websites like https://webhook.site/ can be used as a Test, to catch requests and view content.
  • Within Deployteq, the REST API can currently be used to address the Data Model and Webhooks. Also, we are busy extending the REST APIs, see for example:
    • Zone contents: https://documenter.getpostman.com/view/6603240/SW12yx9V?version=latest
    • Customers: https://documenter.getpostman.com/view/6603240/SzYaUHj8?version=latest

More information about our SOAP API and REST API can be downloaded here.