SOAP

Het SOAP protocol laat u API methodes, via de rijke cliënt, derdetoepassingen aanhalen gebruikend webservices, of JSP gebruikend deze methodes.

De structuur van een SOAP is als volgt:

  • een omhulsel dat de structuur van het bericht aangeeft;
  • een optionele koptekst,
  • een instantie die de informatie over de oproep en de reactie bevat;
  • foutbeheer dat de foutvoorwaarde definieert.

Middelen en uitwisselingen

In het volgende schema ziet u de verschillende bronnen die betrokken zijn bij het gebruik van Adobe Campaign API's:

Voorbeeld van een SOAP bericht over de methode 'ExecuteQuery'

In dit voorbeeld roept een SOAP query de methode "ExecuteQuery" aan, die een tekenreeks neemt als een parameter voor verificatie (sessietoken) en een XML-inhoud voor de beschrijving van de query die moet worden uitgevoerd.

Voor verdere informatie, verwijs naar ExecuteQuery (xtk:queryDef).

NOTE
De beschrijving van WSDL van deze dienst wordt voltooid in het hier getoonde voorbeeld: de dienstbeschrijving van het Web: WSDL.

SOAP

<?xml version='1.0' encoding='ISO-8859-1'?>
  <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='http://xml.apache.org/xml-soap' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
    <SOAP-ENV:Body>
      <ExecuteQuery xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
        <__sessiontoken xsi:type='xsd:string'/>
        <entity xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
          <queryDef firstRows="true" lineCount="200" operation="select" schema="nms:rcpGrpRel" startLine="0" startPath="/" xtkschema="xtk:queryDef">
          ...
          </queryDef>
        </entity>
      </ExecuteQuery>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Het element <soap-env:envelope> is het eerste element van het bericht dat de SOAP omhulsel vertegenwoordigt.

Het element <soap-env:body> is het eerste onderliggende element van de omhulling. Het bevat de beschrijving van het bericht, d.w.z. de inhoud van de vraag of de reactie.

De methode die moet worden aangeroepen, wordt in het element <executequery> ingevoerd vanuit de hoofdtekst van het SOAP.

SOAP worden de parameters op volgorde van weergave herkend. De eerste parameter, <__sessiontoken> , neemt de verificatieketen, de tweede parameter is de XML-beschrijving van de query van het <querydef> -element.