Show Menu
主题×

Web服务调用

一般信息

所有API方法都以Web服务的形式呈现。 这使您能够通过SOAP调用管理所有Adobe Campaign功能,SOAP调用是Adobe Campaign应用程序服务器的本机入口点。 Adobe Campaign控制台本身仅使用SOAP调用。
Web服务允许您从第三方系统创建许多应用程序:
  • 从后台或交易系统执行同步警报、通知和实时交付模板
  • 开发具有简化功能(Web界面等)的特殊界面,
  • 在遵守贸易规则和与基础物理模型保持隔离的同时提供和查找数据库中的数据。

Web服务的定义

在Adobe Campaign应用程序服务器上实现的Web服务的定义可从数据架构中获取。
Web服务在数据模式的语法中描述,并且可从元素中使 <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>

这里我们有一个名为GenerateForm的方法定义的 示例
服务的描述以元素开 <method> 头。 该方法的参数列表从元素中完成 <parameters> 。 每个参数由名称、类型(Boolean、string、DOMElement等)指定和描述。 带有“out”值的“inout”属性允许您指定“result”参数位于SOAP调用输出。
存在“static”属性(带有值“true”)将此方法描述为静态,这意味着必须声明该方法的所有参数。
“const”方法隐式地将XML文档作为其输入,其格式为其关联的模式。
Adobe Campaign架构的元 <method> 素的完整说明位于 <method> 元素 <method> 元素。
“xtk:queryDef”架构中的“const”类型“ExecuteQuery”方法示例:
<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>

此方法的输入参数是格式为“xtk:queryDef”架构的XML文档。

Web服务描述:WSDL

每个服务都有一个WSDL(Web服务描述库)文件。 此XML文件使用元语言描述服务,并指定可用的方法、参数和服务器以联系执行服务。

WSDL文件生成

要生成WSDL文件,必须从Web浏览器输入以下URL:
[https:// <server> /nl/jsp/schemawsdl.jsp?schema= <schema>
With:
  • <server> :adobe Campaign应用程序服务器(nlserver web)
  • <schema> :架构标识密钥(namespace:schema_name)

架构“xtk:queryDef”的“ExecuteQuery”方法示例

WSDL文件是从URL生成的:
WSDL描述首先定义用于形成消息的类型,这些类型与“端口”中的消息关联,通过“绑定”来形成Web服务。

类型

类型定义基于XML架构。 在我们的示例中,“ExecuteQuery”方法使用“s:string”字符串和XML文档( <s:complextype> )作为参数。 方法的返回值(“ExecuteQueryResponse”)是XML文档( <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>

消息

<message> 文描述一组要发送的字段的名称和类型。 该方法使用两条消息作为参数(“ExecuteQueryIn”)和返回值(“ExecuteQueryOut”)传递。
<message name="ExecuteQueryIn">
  <part element="tns:ExecuteQuery" name="parameters"/>
</message>

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

PortType

<porttype> 由生成响应(“输出”)的查询(“输入”)触发的“ExecuteQuery”操作的消息关联。
<portType name="queryDefMethodsSoap">
  <operation name="ExecuteQuery">
    <input message="tns:ExecuteQueryIn"/>
    <output message="tns:ExecuteQueryOut"/>
  </operation>
</portType>

绑定

该部 <binding> 分指定SOAP通信协议( <soap:binding> )、HTTP中的数据传输(“transport”属性的值)和“ExecuteQuery”操作的数据格式。 SOAP封套的正文直接包含消息段,无需转换。
<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>

服务

本部 <service> 分介绍“XtkQueryDef”服务及其URI(位于Adobe Campaign应用程序服务器的URL上)。
<service name="XtkQueryDef">
  <port binding="tns:queryDefMethodsSoap" name="queryDefMethodsSoap">
    <soap:address location="https://localhost/nl/jsp/soaprouter.jsp"/>
  </port>
</service>

连接性

Adobe Campaign通过引入安全区(请参阅本节中的“定义安全区 ”一章 定义安全区 )和会话管理设置,提高了身份验证机制的安全性。
有两种可用的身份验证模式:
  • 通过对logon方法()的调用 。 此模式生成会话令牌和安全令牌。 它是最安全的模式,因此也是最推荐的模式。
  • 通过创建会话令牌的Adobe Campaign登录名 +密码。 会话令牌会在设置的时间段后自动过期。 不建议使用此模式,并要求为某些区域设置(allowUserPassword="true"和sessionTokenOnly="true")减少应用程序安全设置。

会话令牌特性

会话令牌具有以下特征:
  • a x小时生命周期(在“serverConf.xml”文件中可配置生命周期,默认时间段为24小时)
  • 随机构造(不再包含用户登录名和口令)
  • 当通过Web访问时:
    • 会话令牌变为永久令牌,在浏览器关闭后不会销毁
    • 它位于仅HTTP的Cookie中(必须为操作符激活Cookie)

安全令牌特性

安全令牌具有以下特征:
  • 它是从会话令牌生成的
  • 它有一个24小时的生命周期(可在“serverConf.xml”文件中配置,默认时间段为24小时)
  • 它存储在Adobe Campaign控制台中
  • 当通过Web访问时:
    • 它存储在文档中。__securityToken属性
    • 页面URL将更新为安全令牌
    • 表单也通过包含令牌的隐藏字段进行更新

安全令牌移动

通过控制台访问时,它是:
  • 在登录响应中传输(在HTTP头中)
  • 在每个查询中使用(在HTTP头中)
从POST和GET HTTP:
  • 服务器使用令牌完成链接
  • 服务器向表单添加隐藏字段
从SOAP调用:
  • 添加到呼叫头

调用示例

  • 使用 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())
    
    
  • 使用 HttpServletRequest :
以下 HttpServletRequest ,调用中使用的URL需要在serverConf.xml文件的url权限部分 中列入白名单 。 服务器本身的URL也是如此。
登录执行():
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);

查询执行:
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)