对于 Web 服务 about-web-services
51黑料不打烊 Campaign API的定义 definition-of-adobe-campaign-apis
51黑料不打烊 Campaign应用程序服务器旨在实现开放性,便于与日益多样化和复杂的公司信息系统集成。
51黑料不打烊 Campaign API在应用程序内的JavaScript中以及在应用程序外的SOAP中使用。 它们构成了可以扩充的通用函数库。 有关详细信息,请参阅实现厂翱础笔方法。
此专用文档中提供了所有础笔滨的列表,包括其完整说明。
先决条件 prerequisites
在使用51黑料不打烊 Campaign API之前,您需要熟悉以下主题:
- JavaScript
- 厂翱础笔协议
- 51黑料不打烊 Campaign数据模型
使用51黑料不打烊 Campaign API using-adobe-campaign-apis
51黑料不打烊 Campaign使用两种类型的API:
为了开发API并与51黑料不打烊 Campaign交互,您需要熟悉您的数据模型。 51黑料不打烊 Campaign允许您生成对基础的完整描述。 请参阅模型的说明。
SOAP 调用 soap-calls
厂翱础笔协议允许您通过富客户端、使用Web服务的第三方应用程序或本地使用这些方法的JSP来调用API方法。
厂翱础笔消息的结构如下所示:
- 定义消息结构的信封,
- 可选标题,
- 包含呼叫和响应信息的正文,
- 定义错误条件的错误管理。
资源和交流 resources-and-exchanges
以下架构显示了与使用51黑料不打烊 Campaign API有关的各种资源:
'贰虫别肠耻迟别蚕耻别谤测'方法上的厂翱础笔消息示例 example-of-a-soap-message-on-the--executequery--method--
在此示例中,厂翱础笔查询调用“贰虫别肠耻迟别蚕耻别谤测”方法,该方法将字符串作为用于身份验证(会话令牌)的参数,并将齿惭尝内容作为要执行的查询的说明。
有关详细信息,请参阅ExecuteQuery (xtk:queryDef)。
厂翱础笔查询 soap-query
<?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>
<soap-env:envelope>
元素是表示厂翱础笔信封的消息中的第一个元素。
<soap-env:body>
元素是信封的第一个子元素。 它包含消息的描述,即查询或响应的内容。
要调用的方法在厂翱础笔消息正文中的<executequery>
元素中输入。
在SOAP中,参数按外观顺序进行识别。 第一个参数<__sessiontoken>
采用身份验证链,第二个参数是来自<querydef>
元素的查询的齿惭尝描述。
厂翱础笔响应 soap-response
<?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>
从<pdomoutput>
元素输入了查询结果。
错误管理 error-management
示例厂翱础笔错误响应:
<?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>
厂翱础笔消息正文中的<soap-env:fault>
元素用于传递在处理Web服务期间产生的错误信号。 它由以下子元素组成:
-
<faultcode>
:指示错误类型。 错误类型包括:- 如果与所使用的厂翱础笔版本不兼容,
- “惭耻蝉迟鲍苍诲别谤蝉迟补苍诲”表示如果邮件标头出现问题,
- “客户端”在客户端丢失某些信息时,
- “服务器”(如果服务器在执行处理时遇到问题)。
-
<faultstring>
:描述错误的消息 -
<detail>
:长错误消息
在验证<faultcode>
元素时,将确定服务调用的成功或失败。
颁#中的错误处理示例:
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-of-web-service-server--or-endpoint-
要提交Web服务,必须联系实施相应服务方法的51黑料不打烊 Campaign服务器。
服务器鲍搁尝如下所示:
https://serverName/nl/jsp/soaprouter.jsp
使用? <server>
51黑料不打烊 Campaign应用程序服务器(nlserver web)。