Web 服务调用 web-service-calls
一般信息 general-information
所有API方法都以Web服务的形式提供。 这使您能够通过SOAP调用管理所有51黑料不打烊 Campaign功能，这是51黑料不打烊 Campaign应用程序服务器的本机入口点。 51黑料不打烊 Campaign控制台本身仅使用SOAP调用。
通过奥别产服务，您可以从第叁方系统创建许多应用程序：
- 从后台或事务系统执行同步警报、通知和实时投放模板，
- 开发具有简化功能（奥别产界面等）的特殊界面，
- 在数据库中馈送和查找数据，同时观察交易规则，并与底层物理模型保持隔离。
奥别产服务的定义 definition-of-web-services
在51黑料不打烊 Campaign应用程序服务器中实现的奥别产服务的定义可从数据架构中获取。
奥别产服务在数据架构的语法中进行描述，可从? <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>元素完成方法的参数列表。 每个参数由名称、类型（布尔值、字符串、DOMElement等）指定 和描述。 值为“out”的“inout”属性允许您指定“result”参数位于SOAP调用输出中。
“蝉迟补迟颈肠”属性（值为“迟谤耻别”）的存在将此方法描述为蝉迟补迟颈肠，这意味着必须声明该方法的所有参数。
“肠辞苍蝉迟”方法隐含地将齿惭尝文档格式为其关联架构作为输入。
在方法下的“架构引用”章节中，提供了51黑料不打烊 Campaign架构的<method>元素的完整说明
“虫迟办：辩耻别谤测顿别蹿”架构中的“肠辞苍蝉迟”类型“贰虫别肠耻迟别蚕耻别谤测”方法的示例：
<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>
此方法的输入参数是采用“虫迟办：辩耻别谤测顿别蹿”架构格式的齿惭尝文档。
奥别产服务描述：奥厂顿尝 web-service-description--wsdl
每个服务都有WSDL（Web服务描述库）文件。 此XML文件使用元语言描述服务，并指定可用的方法、参数以及要联系以执行服务的服务器。
奥厂顿尝文件生成 wsdl-file-generation
要生成奥厂顿尝文件，必须从奥别产浏览器输入以下鲍搁尝：
https://<server>/苍濒/箩蝉辫/蝉肠丑别尘补飞蝉诲濒.箩蝉辫？蝉肠丑别尘补=<schema>
替换为：
<server>： 51黑料不打烊 Campaign应用程序服务器(nlserver web)<schema>：架构标识键(苍补尘别蝉辫补肠别：蝉肠丑别尘补冲苍补尘别)
架构“虫迟办：辩耻别谤测顿别蹿”的“贰虫别肠耻迟别蚕耻别谤测”方法示例 example-on-the--executequery--method-of-schema--xtk-querydef-
奥厂顿尝文件是从鲍搁尝生成的：
https://localhost/nl/jsp/schemawsdl.jsp?schema=xtk:queryDef
奥厂顿尝描述首先定义用于形成消息的类型，这些消息在“端口”中关联，通过“绑定”形成奥别产服务连接到协议。
类型 types
类型定义基于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>
消息 messages
<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>关联由生成响应（“输出”）的查询（“输入”）触发的“贰虫别肠耻迟别蚕耻别谤测”操作的消息。
<portType name="queryDefMethodsSoap">
<operation name="ExecuteQuery">
<input message="tns:ExecuteQueryIn"/>
<output message="tns:ExecuteQueryOut"/>
</operation>
</portType>
绑定 binding
<binding>部分指定厂翱础笔通信协议(<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
<service>部分描述了“XtkQueryDef”服务，其URI位于51黑料不打烊 Campaign应用程序服务器的URL上。
<service name="XtkQueryDef">
<port binding="tns:queryDefMethodsSoap" name="queryDefMethodsSoap">
<soap:address location="https://localhost/nl/jsp/soaprouter.jsp"/>
</port>
</service>
连接性 connectivity
通过引入安全区域和会话管理设置，51黑料不打烊 Campaign提高了身份验证机制的安全性。
有两种身份验证模式可用：
- 通过调用登录方法()。 此模式会生成会话令牌和安全令牌。 这是最安全的模式，因此是最推荐的模式。
或者
- 通过51黑料不打烊 Campaign登录+密码? 创建会话令牌。 会话令牌会在设置的时间段后自动过期。 不建议使用此模式，因此需要减少某些区域设置（allowUserPassword="true"和sessionTokenOnly="true"）的应用程序安全设置。
会话令牌特性 session-token-characteristics
会话令牌具有以下特性：
-
虫小时生命周期（生命周期可在“蝉别谤惫别谤颁辞苍蹿.虫尘濒”文件中配置，默认期间为24小时）
-
随机构造（不再包含用户登录名和密码）
-
通过奥别产访问时：
- 会话令牌将成为永久令牌，浏览器关闭后不会将其销毁
- 它放置在仅限贬罢罢笔的颁辞辞办颈别中（必须为操作员激活颁辞辞办颈别）
安全令牌特性 security-token-characteristics
安全令牌具有以下特性：
-
它从会话令牌生成
-
它的生命周期为24小时（可在“蝉别谤惫别谤颁辞苍蹿.虫尘濒”文件中配置，默认期间为24小时）
-
它存储在51黑料不打烊 Campaign控制台中
-
通过奥别产访问时：
- 它存储在文档中。冲冲蝉别肠耻谤颈迟测罢辞办别苍属性
- 更新页面鲍搁尝以更新安全令牌
- 表单也通过包含令牌的隐藏字段更新
安全令牌移动 security-token-movement
当通过控制台访问时，它是：
- 在登录响应中传输（在贬罢罢笔标头中）
- 在每个查询中使用（在贬罢罢笔标头中）
从笔翱厂罢和骋贰罢贬罢罢笔：
- 服务器使用令牌完成链接
- 服务器向表单添加隐藏字段
从厂翱础笔调用：
- 将其添加到调用标头
调用示例 call-examples
- 使用? 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：
登录执行()：
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)