Über Web-Dienste

Definition der Adobe Campaign-APIs

Der Adobe Campaign-Anwendungsserver wurde für Offenheit und einfache Integration in immer vielfältigere und komplexere Unternehmensinformationssysteme entwickelt.

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 Implementieren von SOAP-Methoden.

Voraussetzungen

Vor der Arbeit mit Adobe Campaign-APIs sollten Sie sich mit den folgenden Themen vertraut machen:

• JavaScript
• SOAP-Protokoll
• Adobe Campaign-Datenmodell

Verwenden von Adobe Campaign-APIs

Adobe Campaign verwendet zwei API-Typen:

• APIs zum allgemeinen Datenzugriff, mittels derer Datenmodell-Daten abgefragt werden können. Näheres hierzu finden Sie unter Datenorientierte APIs.
• Business-orientierte APIs, mit denen Sie auf diese einzelnen Objekte, also Versand, Workflows, Abonnements usw., Aktionen ausführen können. Siehe Geschäftsorientierte APIs.

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

SOAP-Aufrufe

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

Eine SOAP-Nachricht weist folgende Struktur auf:

• einen Umschlag, der die Nachrichtenstruktur festlegt,
• eine optionale Kopfzeile,
• einen Text mit Informationen zum Aufruf und zur Antwort,
• Fehlerverwaltung, die die Fehlerbedingung definiert.

Ressourcen und Austausch

Das folgende Schema zeigt die verschiedenen Ressourcen, die an der Verwendung von Adobe Campaign-APIs beteiligt sind:

Beispiel einer SOAP-Nachricht für die Methode 'ExecuteQuery'

In diesem Beispiel ruft eine SOAP-Abfrage die Methode "ExecuteQuery"auf, die eine Zeichenkette als Parameter für die Authentifizierung (Sitzungstoken) und einen XML-Inhalt für die Beschreibung der auszuführenden Abfrage akzeptiert.

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

SOAP-Abfrage

<?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 Element <soap-env:envelope> ist das erste Element der Nachricht, das den SOAP-Umschlag darstellt.

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

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

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

SOAP-Antwort

<?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 aus dem Element <pdomoutput> eingegeben.

Umgang mit Fehlern

Beispiel für 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 Element <soap-env:fault> im Textkörper der SOAP-Nachricht wird verwendet, um die bei der Verarbeitung des Webdienstes auftretenden Fehlersignale zu übermitteln. Dies setzt sich aus den folgenden Unterelementen zusammen:

• <faultcode> : gibt den Fehlertyp an. Die Fehlertypen sind:

  • "VersionMismatch" im Fall der Inkompatibilität mit der verwendeten SOAP-Version,
  • "MustUnderstand"im Fall eines Problems in der Kopfzeile der Nachricht,
  • "Client", falls dem Client einige Informationen fehlen,
  • "Server", wenn der Server ein Problem bei der Ausführung der Verarbeitung hat.

• <faultstring> : Fehlermeldung

• <detail> : Lange Fehlermeldung

Der Erfolg oder Misserfolg des Dienstaufrufs wird bei der Überprüfung des Elements <faultcode> identifiziert.

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 Webdienstservers (oder 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

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