Show Menu
THEMEN×

Webdienste

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 generischer Funktionen, die bereichert werden können. Weitere Informationen finden Sie unter SOAP- Methoden implementieren.
Die Anzahl der autorisierten Engine-Aufrufe pro Tag hängt von Ihrem Lizenzvertrag ab. Weiterführende Informationen hierzu finden Sie auf dieser Seite . Eine Liste aller APIs mit ihrer vollständigen Beschreibung finden Sie in dieser Dokumentation .

Voraussetzungen

Bevor Sie die Adobe Campaign-APIs verwenden, müssen Sie sich mit den folgenden Themen vertraut machen:
  • Javascript
  • SOAP-Protokoll
  • Adobe Campaign-Datenmodell

Using Adobe Campaign APIs

Adobe Campaign verwendet zwei Arten von APIs:
  • Generische Daten greifen auf APIs zum Abfragen der Datenmodelldaten zu. Siehe datenorientierte APIs .
  • Geschäftsspezifische APIs, mit denen Sie für jedes Objekt handeln können: Auslieferungen, Arbeitsabläufe, Abonnements usw. 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, die Webdienste verwenden, oder JSP mit diesen Methoden nativ aufrufen.
Die Struktur einer SOAP-Nachricht lautet wie folgt:
  • einen Umschlag, der die Struktur der Nachricht definiert,
  • eine optionale Kopfzeile,
  • eine Stelle, die Informationen über den Aufruf und die Antwort enthält,
  • Fehlerverwaltung, die die Fehlerbedingung definiert.

Ressourcen und Austausch

Das folgende Schema zeigt die verschiedenen Ressourcen, die für die Verwendung der Adobe Campaign-APIs erforderlich sind:

Beispiel einer SOAP-Meldung bei der Methode 'ExecuteQuery'

In diesem Beispiel ruft eine SOAP-Abfrage die Methode "ExecuteQuery"auf, die eine Zeichenfolge 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) .
Die WSDL-Beschreibung dieses Dienstes ist im folgenden Beispiel abgeschlossen: Beschreibung des Webdiensts: WSDL .

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 <soap-env:envelope> Element ist das erste Element der Meldung, das den SOAP-Umschlag darstellt.
Das <soap-env:body> Element ist das erste untergeordnete Element der Hülle. Es enthält die Beschreibung der Nachricht, d.h. den Inhalt der Abfrage oder der Antwort.
Die aufzurufende Methode wird aus dem Hauptteil der SOAP-Nachricht in das <executequery> Element eingegeben.
In SOAP werden die Parameter in der Reihenfolge ihres Erscheinungsbilds erkannt. Der erste Parameter nimmt <__sessiontoken> die Authentifizierungskette und der zweite Parameter die XML-Beschreibung der Abfrage des <querydef> Elements.

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 <pdomoutput> Element 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 <soap-env:fault> Element im Textkörper der SOAP-Meldung wird verwendet, um die Fehlersignale zu vermitteln, die bei der Verarbeitung des Webdiensts auftreten. Dies setzt sich aus den folgenden Unterelementen zusammen:
  • <faultcode> : gibt den Fehlertyp an. Die Fehlertypen sind:
    • "VersionMismatch" bei Inkompatibilität mit der verwendeten SOAP-Version,
    • "MustUnderstand" bei einem Problem im Nachrichtenkopf,
    • "Client", falls dem Kunden Informationen fehlen,
    • "Server", wenn der Server ein Problem beim Ausführen der Verarbeitung hat.
  • <faultstring> : Meldung, die den Fehler beschreibt
  • <detail> : Lange Fehlermeldung
Der Erfolg oder Misserfolg des Dienstaufrufs wird bei der Überprüfung des <faultcode> Elements identifiziert.
Alle Adobe Campaign-Webdienste behandeln Fehler. Es wird daher dringend empfohlen, jeden Aufruf zu testen, um zurückgegebene Fehler zu behandeln.
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)

Zum Senden des Webdiensts 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 ).