Todos os métodos de API são apresentados na forma de serviços da Web. Isso permite gerenciar todas as funções do Adobe Campaign por meio de chamadas SOAP, que são o ponto de entrada nativo do servidor de aplicativos Adobe Campaign. O próprio console Adobe Campaign só usa chamadas SOAP.
Os serviços da Web permitem criar muitos aplicativos a partir de um sistema de terceiros:
A definição dos serviços da Web implementados no servidor de aplicativos do Adobe Campaign está disponível nos schemas de dados.
Um serviço da Web é descrito na gramática dos schemas de dados e está disponível no <methods>
elemento.
<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>
Aqui temos um exemplo da definição do método chamado GenerateForm.
A descrição do serviço começa com a variável <method>
elemento. A lista de parâmetros do método é concluída no <parameters>
elemento. Cada parâmetro é especificado por um nome, um tipo (Booliano, string, DOMElement, etc.) e uma descrição. O atributo "inout" com o valor "out" permite especificar que o parâmetro "result" está na saída da chamada SOAP.
A presença do atributo "static" (com o valor "true") descreve esse método como estático, o que significa que todos os parâmetros do método devem ser declarados.
Um método "const" tem implicitamente um documento XML no formato de seu schema associado como entrada.
Uma descrição completa da <method>
O elemento de um schema Adobe Campaign está disponível no capítulo "Referências de schema" em Método
Exemplo do método "const"-type "ExecuteQuery" do schema "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>
O parâmetro de entrada desse método é um documento XML no formato do schema "xtk:queryDef".
Um arquivo WSDL (Biblioteca de descrição do serviço da Web) está disponível para cada serviço. Esse arquivo XML usa um idioma de metal para descrever o serviço e especificar os métodos, parâmetros e o servidor disponíveis para entrar em contato com o para executar o serviço.
Para gerar um arquivo WSDL, você deve inserir o seguinte URL de um navegador da Web:
https://<server>
/nl/jsp/schemawsdl.jsp?schema=<schema>
Com:
<server>
: o servidor de aplicativos do Adobe Campaign (nlserver web)<schema>
: chave de identificação do schema (namespace:schema_name)O arquivo WSDL é gerado a partir do URL:
https://localhost/nl/jsp/schemawsdl.jsp?schema=xtk:queryDef
Uma descrição WSDL começa definindo os tipos usados para formar mensagens, associadas em "portas", conectadas a um protocolo por "vínculos" formando serviços da Web.
As definições de tipo são baseadas em esquemas XML. No nosso exemplo, o método "ExecuteQuery" utiliza uma string "s:string" e um documento XML (<s:complextype>
) como parâmetros. O valor de retorno do método ("ExecuteQueryResponse") é um documento 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>
O <message>
descreve os nomes e os tipos de um conjunto de campos a serem enviados. O método usa duas mensagens para passar como parâmetro ("ExecuteQueryIn") e o valor de retorno ("ExecuteQueryOut").
<message name="ExecuteQueryIn">
<part element="tns:ExecuteQuery" name="parameters"/>
</message>
<message name="ExecuteQueryOut">
<part element="tns:ExecuteQueryResponse" name="parameters"/>
</message>
O <porttype>
associa as mensagens na operação "ExecuteQuery" acionada pela consulta ("input") que gera uma resposta ("output").
<portType name="queryDefMethodsSoap">
<operation name="ExecuteQuery">
<input message="tns:ExecuteQueryIn"/>
<output message="tns:ExecuteQueryOut"/>
</operation>
</portType>
O <binding>
parte especifica o protocolo de comunicação SOAP ( <soap:binding>
), o transporte de dados em HTTP (valor do atributo "transport") e o formato dos dados para a operação "ExecuteQuery". O corpo do envelope SOAP contém os segmentos de mensagem diretamente sem transformação.
<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>
O <service>
parte descreve o serviço "XtkQueryDef" com seu URI no URL do servidor de aplicativos do Adobe Campaign.
<service name="XtkQueryDef">
<port binding="tns:queryDefMethodsSoap" name="queryDefMethodsSoap">
<soap:address location="https://localhost/nl/jsp/soaprouter.jsp"/>
</port>
</service>
A Adobe Campaign aumentou a segurança dos mecanismos de autenticação ao introduzir zonas de segurança e configurações de gerenciamento de sessão.
Há dois modos de autenticação disponíveis:
ou
O token de sessão tem as seguintes características:
um ciclo de vida de X hora (o ciclo de vida é configurável no arquivo 'serverConf.xml', o período padrão é de 24 horas)
uma construção aleatória (não contém mais o login do usuário e a senha)
quando acessado via Web:
O token de segurança tem as seguintes características:
é gerado pelo token de sessão
tem um ciclo de vida de 24 horas (configurável no arquivo 'serverConf.xml', o período padrão é de 24 horas)
é armazenado no console Adobe Campaign
quando acessado via Web:
Quando acessado por meio do console, é:
De um POST e GET HTTP:
Em uma chamada SOAP:
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())
Os URLs usados no seguinte HttpServletRequest as chamadas precisam estar no lista de permissões na seção de permissões de url do serverConf.xml arquivo. Isso também é verdadeiro para o URL do próprio servidor.
Execução de logon():
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);
Execução da consulta:
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)