Über Web-Dienste about-web-services

Definition der Adobe Campaign-APIs definition-of-adobe-campaign-apis

Der Adobe Campaign-Anwendungsserver wurde für Offenheit und einfache Integration mit immer vielfältigeren und komplexeren Unternehmensinformationssystemen konzipiert.

Adobe Campaign-APIs werden in JavaScript innerhalb der Anwendung und in SOAP außerhalb der Anwendung verwendet. Sie bilden eine Bibliothek allgemeiner Funktionen, die angereichert werden können. Weitere Informationen finden Sie unter von SOAP-Methoden.

Voraussetzungen prerequisites

Bevor Sie die Adobe Campaign-APIs verwenden, müssen Sie mit den folgenden Themen vertraut sein:

Verwenden von Adobe Campaign-APIs using-adobe-campaign-apis

Adobe Campaign verwendet zwei Arten von APIs:

Um APIs entwickeln und mit Adobe Campaign interagieren zu können, müssen Sie mit Ihrem Datenmodell vertraut sein. Mit Adobe Campaign können Sie eine vollständige Beschreibung der Basis generieren. Siehe Beschreibung des Modells.

SOAP-Aufrufe soap-calls

Mit dem SOAP-Protokoll können Sie API-Methoden über den Rich-Client oder Anwendungen von Drittanbietern mithilfe von Web-Services oder JSP aufrufen, indem Sie diese Methoden nativ verwenden.

Eine SOAP-Nachricht weist folgende Struktur auf:

Ressourcen und Austausch resources-and-exchanges

Das folgende Schema zeigt die verschiedenen Ressourcen, die bei der Verwendung von Adobe Campaign-APIs zum Einsatz kommen:

Beispiel einer SOAP-Nachricht mit der Methode „ExecuteQuery“ example-of-a-soap-message-on-the--executequery--method--

In diesem Beispiel ruft eine SOAP-Abfrage die Methode „ExecuteQuery“ auf, die eine Zeichenfolge als Authentifizierungsparameter (Sitzungs-Token) und einen XML-Inhalt für die Beschreibung der auszuführenden Abfrage benötigt.

Weitere Informationen finden Sie unter ExecuteQuery (xtk:queryDef).

SOAP-Abfrage soap-query

<?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>

Das <soap-env:envelope> ist das erste Element der Nachricht, das den SOAP-Umschlag darstellt.

Das <soap-env:body> ist das erste untergeordnete Element der Envelope. Sie enthält die Beschreibung der Nachricht, d. h. den Inhalt der Abfrage oder der Antwort.

Die aufzurufende Methode wird im <executequery> aus dem Hauptteil der SOAP-Nachricht eingegeben.

In SOAP werden die Parameter anhand der Reihenfolge des Erscheinungsbilds erkannt. Der erste Parameter übernimmt <__sessiontoken> die Authentifizierungskette, der zweite Parameter ist die XML-Beschreibung der Abfrage aus dem <querydef>.

SOAP-Antwort soap-response

<?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>
      <ExecuteQueryResponse xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
        <pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
          <rcpGrpRel-collection><rcpGrpRel group-id="1872" recipient-id="1362"></rcpGrpRel></rcpGrpRel-collection>
        </pdomOutput>
      </ExecuteQueryResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Das Ergebnis der Abfrage wird über das <pdomoutput> eingegeben.

Umgang mit Fehlern error-management

Beispiel einer SOAP-Fehlerantwort:

<?xml version='1.0' encoding='ISO-8859-1'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <SOAP-ENV:Fault>
      <faultcode>SOAP-ENV:Server</faultcode>
      <faultstring>Error while executing 'Write' of the 'xtk:persist'.</faultstring> service
      <detail>ODBC error: [Microsoft][ODBC SQL Server Driver][SQL Server]Cannot insert duplicate key row in object 'XtkOption' with unique index 'XtkOption_name'. SQLSTate: 23000
ODBC error: [Microsoft][ODBC SQL Server Driver][SQL Server]The statement has been terminated. SQLSTate: 01000 Cannot save the 'Options (xtk:option)' document </detail>
    </SOAP-ENV:Fault>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Das <soap-env:fault> im Textkörper der SOAP-Nachricht dient zur Übermittlung der bei der Verarbeitung des Webdienstes auftretenden Fehlersignale. Dieses besteht aus den folgenden Unterelementen:

Der Erfolg oder Misserfolg des Service-Aufrufs wird identifiziert, wenn das <faultcode> überprüft wird.

Beispiel für die Fehlerbehandlung in C#:

try
{
  // Invocation of method
  ...
}
catch (SoapException e)
{
  System.Console.WriteLine("Soap exception: " + e.Message);
  if (e.Detail != null)
    System.Console.WriteLine(e.Detail.InnerText);
}

URL des Webservice-Servers (oder Endpunkts) url-of-web-service-server--or-endpoint-

Um den Webdienst zu übermitteln, muss der Adobe Campaign-Server kontaktiert werden, der die entsprechende Dienstmethode implementiert.

Die Server-URL lautet wie folgt:

https://serverName/nl/jsp/soaprouter.jsp

<server> mit dem Adobe Campaign-Anwendungsserver (nlserver web).