Dokumentation Campaign Dokumentation för Campaign Classic v7

Webbtjänstanrop

Senast uppdaterad: 19 juli 2024

Ämnen:
API

Skapat för:

Utvecklare

Allmän information

Alla API-metoder presenteras i form av webbtjänster. På så sätt kan du hantera alla Adobe Campaign-funktioner via SOAP, som är startpunkten för Adobe Campaign programserver. Adobe Campaign-konsolen använder bara SOAP samtal.

Med webbtjänster kan du skapa många program från ett tredjepartssystem:

Synkrona aviseringar, meddelanden och mallkörning i realtid från ett back office- eller transaktionssystem.
Utveckling av specialgränssnitt med förenklad funktionalitet (webbgränssnitt osv.).
Matning och sökning av data i databasen, med iakttagande av handelsregler och som förblir isolerade från den underliggande fysiska modellen.

Definition av webbtjänster

Definitionen av de webbtjänster som implementeras på Adobe Campaign programserver finns i dataschemat.

En webbtjänst beskrivs i datarappningens grammatik och är tillgänglig från elementet <methods>.

<methods>
  <method name="GenerateForm" static="true">
    <help>Generates the form in Mail or Web mode</help>
    <parameters>
      <param name="formName" type="string" desc="Name of form"/>
      <param name="mailMode" type="boolean" desc="Generate a form of type Mail"/>
      <param name="result" type="string" inout="out" desc="Result "/>
    </parameters>
  </method>
</methods>

Här finns ett exempel på definitionen av metoden GenerateForm.

Tjänstens beskrivning börjar med elementet <method>. Listan med parametrar för metoden har slutförts från elementet <parameters>. Varje parameter anges med ett namn, en typ (Boolean, sträng, DOMElement osv.) och en beskrivning. Med attributet "inout" med värdet "out" kan du ange att parametern "result" finns i SOAP anropsutdata.

Förekomsten av attributet"static" (med värdet"true") beskriver metoden som statisk, vilket betyder att alla parametrar för metoden måste deklareras.

En const-metod har implicit ett XML-dokument i det associerade schemats format som indata.

En fullständig beskrivning av elementet <method> i ett Adobe Campaign-schema finns i kapitlet "Schemareferenser" under Metod

Exempel på "const"-typ "ExecuteQuery"-metoden från schemat "xtk:queryDef":

<method name="ExecuteQuery" const="true">
  <help>Retrieve data from a query</help>
  <parameters>
    <param desc="Output xml document" name="output" type="DOMDocument" inout="out"/>
  </parameters>
</method>

Indataparametern för den här metoden är ett XML-dokument i formatet för schemat "xtk:queryDef".

Beskrivning av webbtjänst: WSDL

Det finns en WSDL-fil (Web Service Description Library) för varje tjänst. I den här XML-filen används ett språk för att beskriva tjänsten och ange tillgängliga metoder, parametrar och servern som ska kontaktas för att tjänsten ska kunna köras.

WSDL-filgenerering

Om du vill generera en WSDL-fil måste du ange följande URL från en webbläsare:

https://<server>/nl/jsp/schemawsdl.jsp?schema=<schema>

Med:

<server>: Adobe Campaign programserver (nlserver web)
<schema>: schemaidentifieringsnyckel (namnrymd:schema_name)

Exempel på metoden ExecuteQuery i schemat xtk:queryDef

WSDL-filen genereras från URL

https://localhost/nl/jsp/schemawsdl.jsp?schema=xtk:queryDef

En WSDL-beskrivning börjar med att definiera de typer som används för att skapa formulärmeddelanden, som är kopplade till portar, som är kopplade till ett protokoll av bindningar som skapar webbtjänster.

Typer

Typdefinitioner baseras på XML-scheman. I det här exemplet använder metoden"ExecuteQuery" strängen"s:string" och ett XML-dokument (<s:complextype>) som parametrar. Returvärdet för metoden ("ExecuteQueryResponse") är ett XML-dokument ( <s:complextype>).

<types>
<s:schema elementFormDefault="qualified" targetNamespace="urn:xtk:queryDef">
  <s:element name="ExecuteQuery">
    <s:complexType>
      <s:sequence>
        <s:element maxOccurs="1" minOccurs="1" name="sessiontoken" type="s:string"/>
        <s:element maxOccurs="1" minOccurs="1" name="entity">
          <s:complexType>
            <s:sequence>
              <s:any/>
            </s:sequence>
          </s:complexType>
        </s:element>
      </s:sequence>
    </s:complexType>
  </s:element>
  <s:element name="ExecuteQueryResponse">
    <s:complexType>
      <s:sequence>
        <s:element maxOccurs="1" minOccurs="1" name="pdomOutput">
          <s:complexType mixed="true">
            <s:sequence>
              <s:any/>
            </s:sequence>
          </s:complexType>
        </s:element>
      </s:sequence>
    </s:complexType>
  </s:element>

Meddelanden

<message> beskriver namn och typer för en uppsättning fält som ska skickas. I metoden används två meddelanden för att skicka som en parameter ("ExecuteQueryIn") och returvärdet ("ExecuteQueryOut").

<message name="ExecuteQueryIn">
  <part element="tns:ExecuteQuery" name="parameters"/>
</message>

<message name="ExecuteQueryOut">
  <part element="tns:ExecuteQueryResponse" name="parameters"/>
</message>

PortType

<porttype> associerar meddelandena för åtgärden ExecuteQuery som utlöses av frågan ("input") som genererar ett svar ("output").

<portType name="queryDefMethodsSoap">
  <operation name="ExecuteQuery">
    <input message="tns:ExecuteQueryIn"/>
    <output message="tns:ExecuteQueryOut"/>
  </operation>
</portType>

Bindning

<binding>-delen anger SOAP kommunikationsprotokoll ( <soap:binding> ), datatransport i HTTP (värdet för attributet transport) och dataformatet för åtgärden ExecuteQuery. SOAP innehåller meddelandesegmenten direkt utan omformning.

<binding name="queryDefMethodsSoap" type="tns:queryDefMethodsSoap">
  <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
  <operation name="ExecuteQuery">
    <soap:operation soapAction="xtk:queryDef#ExecuteQuery" style="document"/>
    <input>
      <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:xtk:queryDef" use="literal"/>
    </input>
    <output>
      <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:xtk:queryDef" use="literal"/>
    </output>
  </operation>
</binding>

Tjänst

Delen <service> beskriver tjänsten XtkQueryDef med dess URI på URL:en för Adobe Campaign-programservern.

<service name="XtkQueryDef">
  <port binding="tns:queryDefMethodsSoap" name="queryDefMethodsSoap">
    <soap:address location="https://localhost/nl/jsp/soaprouter.jsp"/>
  </port>
</service>

Anslutningar

Adobe Campaign har ökat säkerheten för autentiseringsmekanismer genom att införa säkerhetszoner och inställningar för sessionshantering.

Det finns två autentiseringslägen:

via ett anrop till inloggningsmetoden(). Det här läget genererar en sessionstoken och en säkerhetstoken. Det är det säkraste läget och därför det mest rekommenderade.

eller

via Adobe Campaign-inloggning + lösenord som skapar en sessionstoken. Sessionstoken upphör automatiskt att gälla efter en angiven period. Det här läget rekommenderas inte och kräver att säkerhetsinställningarna för vissa zoninställningar reduceras (allowUserPassword="true" och sessionTokenOnly="true").

Sessionstokensegenskaper

Sessionstoken har följande egenskaper:

en X-timmars livscykel (livscykeln kan konfigureras i filen serverConf.xml, standardperioden är 24 timmar)
en slumpmässig konstruktion (den innehåller inte längre användarens inloggning och lösenord)
på webben:
- sessionstoken blir en permanent token, och tas inte bort när webbläsaren stängs
- den placeras i en HTTP-ONLY-cookie (cookies måste aktiveras för operatorer)

Egenskaper för säkerhetstoken

Säkerhetstoken har följande egenskaper:

den genereras från sessionstoken
har en 24-timmars livscykel (konfigurerbar i filen serverConf.xml, standardperioden är 24 timmar)
lagras i Adobe Campaign Console
på webben:
- det lagras i ett dokument.__securityToken, egenskap
- webbadresserna uppdateras för att uppdatera säkerhetstoken
- formulären uppdateras även via ett dolt fält som innehåller token

Säkerhetstokenförflyttning

När du använder konsolen är det:

skickas i inloggningssvaret (i HTTP-huvudet)
används i varje fråga (i HTTP-huvudet)

Från en POSTS- och GET-HTTP:

servern slutför länkarna med token
servern lägger till ett dolt fält i formulär

Från ett SOAP samtal:

det läggs till för att ringa rubriker

Exempel på utlysningar

Använder HttpSoapConnection/SoapService:


    var cnx = new HttpSoapConnection("https://serverURL/nl/jsp/soaprouter.jsp");
  var session = new SoapService(cnx, 'urn:xtk:session');
  session.addMethod("Logon", "xtk:session#Logon",
                      ["sessiontoken", "string", "Login", "string", "Password", "string", "Parameters", "NLElement"],
                      ["sessionToken", "string", "sessionInfo", "NLElement", "securityToken", "string"]);

  var res = session.Logon("", "admin", "pwd", <param/>);
  var sessionToken = res[0];
  var securityToken = res[2];

  cnx.addTokens(sessionToken, securityToken);
  var query = new SoapService(cnx, 'urn:xtk:queryDef');
  query.addMethod("ExecuteQuery", "xtk:queryDef#ExecuteQuery",
                      ["sessiontoken", "string", "entity", "NLElement"],
                      ["res", "NLElement"]);

  var queryRes = query.ExecuteQuery("", <queryDef operation="select" schema="nms:recipient">
            <select>
              <node expr="@email"/>
              <node expr="@lastName"/>
              <node expr="@firstName"/>
            </select>
            <where>
              <condition expr="@email = 'joe.doe@aol.com'"/>
            </where>
          </queryDef>);
  logInfo(queryRes[0].toXMLString())

Använder HttpServletRequest:

NOTE

De URL:er som används i följande HttpServletRequest -anrop måste finnas på tillåtelselista i behörighetssektionen för serverConf.xml -filen. Detta gäller även för serverns URL.

Inloggningskörning:

var req = new HttpClientRequest("https://serverURL/nl/jsp/soaprouter.jsp");
req.header["Content-Type"] = "text/xml; charset=utf-8";
req.header["SOAPAction"] =   "xtk:session#Logon";
req.method = "POST";
req.body = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:xtk:session">' +
    '<soapenv:Header/>' +
    '<soapenv:Body>' +
        '<urn:Logon>' +
            '<urn:sessiontoken></urn:sessiontoken>' +
            '<urn:strLogin>LOGIN_HERE</urn:strLogin>' +
            '<urn:strPassword>PASSWORD_HERE</urn:strPassword>' +
            '<urn:elemParameters></urn:elemParameters>' +
        '</urn:Logon>' +
    '</soapenv:Body>' +
'</soapenv:Envelope>';
req.execute();

var resp = req.response;
var xmlRes = new XML(String(resp.body).replace("<?xml version='1.0'?>",""));
var sessionToken = String(xmlRes..*::pstrSessionToken);;
var securityToken = String(xmlRes..*::pstrSecurityToken);

Frågekörning:

var req2 = new HttpClientRequest("https://serverURL/nl/jsp/soaprouter.jsp");
req2.header["Content-Type"] = "text/xml; charset=utf-8";
req2.header["SOAPAction"] =   "xtk:queryDef#ExecuteQuery";req2.header["X-Security-Token"] = securityToken;
req2.header["cookie"]           = "__sessiontoken="+sessionToken;
req2.method = "POST";
req2.body = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:xtk:queryDef">' +
             '<soapenv:Header/><soapenv:Body><urn:ExecuteQuery><urn:sessiontoken/><urn:entity>' +
                '<queryDef operation="select" schema="nms:recipient">' +
                  '<select><node expr="@email"/><node expr="@lastName"/><node expr="@firstName"/></select>' +
                  '<where><condition expr="@email = \'john.doe@aol.com\'"/></where>' +
                '</queryDef>' +
           '</urn:entity></urn:ExecuteQuery></soapenv:Body></soapenv:Envelope>';
req2.execute();
var resp2 = req2.response;
logInfo(resp2.body)

recommendation-more-help