DocumentaçãoCampaignDocumentação do Campaign Classic v7

APIs direcionadas por empresas business-oriented-apis

Last update: Fri Apr 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:
  • API

Criado para:

  • Developer

As APIs de negócios são específicas para cada tipo de objeto. Elas têm efeito em:

Esta seção detalha o uso dos serviços "Assinar", "Cancelar assinatura" e "Enviar entrega".

IMPORTANT
Documentação JSAPI do Campaign contém informações adicionais sobre chamadas SOAP e uso do Javascript no Adobe Campaign, bem como uma referência completa a todos os métodos e funções usados no aplicativo.

Assinar (nms:subscription) subscribe--nms-subscription-

Esse serviço permite subscrever um recipient em um serviço de informação e atualizar o perfil do recipient.

Os seguintes parâmetros são necessários para chamar o serviço:

  • uma autenticação,
  • nome interno do serviço de assinatura,
  • um documento XML que contém as informações do recipient (do schema "nms:recipient"),
  • um booleano para criação de recipients, se ainda não houver um.

Descrição do método "subscribe" no schema "nms:subscription":

<method name="Subscribe" static="true">
  <parameters>
     <param name="serviceName" type="string"  desc="List of information service names (comma separated)"/>
     <param name="recipient" type="DOMElement" desc="Recipient"/>
     <param name="create" type="Boolean" desc="Create recipient if it does not exist"/>
   </parameters>
</method>

A definição da chave de reconciliação deve ser inserida por meio do _​ key atributo no <recipient> elemento do documento XML. O conteúdo desse atributo é uma lista XPath separada por vírgulas.

Esta chamada não retorna dados, exceto erros.

Exemplos examples

Subscription with recipient reconciliation key no endereço de email: o documento XML de entrada deve fazer referência ao endereço de email e à definição da chave neste campo.

<recipient _key="email" email= "john.doe@adobe.com"/>

Atualização do recipient e da assinatura.

<recipient _key="email, [folder-id]" email= "john.doe@adobe.com" folder-id="1305" firstName="John" lastName="Doe"/>

Exemplo de mensagens SOAP example-of-soap-messages

  • Consulta:

    code language-none 
    <?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:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <m:Subscribe xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
      <sessiontoken xsi:type='xsd:string'/>
      <service xsi:type='xsd:string'>SVC1</service>
      <content xsi:type='' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
        <recipient _key="@email" email= "john.doe@adobe.com/>
      </content>
      <create xsi:type='xsd:boolean'>true</create>
    </m:Subscribe>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

  • Resposta:

    code language-none 
    <?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>
    <m:SubscribeResponse xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
    </m:SubscribeResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Cancelar assinatura (nms:subscription) unsubscribe--nms-subscription-

Esse serviço permite cancelar a subscrição de um recipient de um serviço de informação e atualizar o perfil do recipient.

Os seguintes parâmetros são necessários para chamar o serviço:

  • uma autenticação,
  • Nome interno do serviço do qual cancelar a assinatura,
  • um documento XML que contém as informações do recipient (do schema "nms:recipient"),

Descrição do método "Unsubscribe" no schema "nms:subscription":

<method name="Unsubscribe" static="true">
  <parameters>
    <param name="serviceName" type="string" desc="List of information service names (comma separated)"/>
    <param name="recipient" type="DOMElement"  desc="Recipient"/>
  </parameters>
</method>

A definição da chave de reconciliação deve ser inserida por meio do atributo _key no <recipient> elemento do documento XML. O conteúdo desse atributo é uma lista XPath separada por vírgulas.

Se o recipient não estiver presente no banco de dados ou não estiver inscrito no serviço de informações relacionado, o serviço não executará nenhuma ação e não gerará um erro.

NOTE
Se o serviço não for especificado como um parâmetro, o recipient será automaticamente incluído na inclui na lista de bloqueios(@blackList="1").

Esta chamada não retorna dados, exceto erros.

Exemplo de mensagens SOAP example-of-soap-messages-1

Consulta:

<?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:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <m:Unsubscribe xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
    <sessiontoken xsi:type='xsd:string'/>
    <service xsi:type='xsd:string'>SVC1</service>
    <content xsi:type='' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
      <recipient _key="@email" email= "john.doe@adobe.com/>
    </content>
  </m:Unsubscribe>
</SOAP-ENV:Body>

Resposta:

<?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>
    <m:UnsubscribeResponse xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
    </m:UnsubscribeResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SubmitDelivery (nms:delivery) submitdelivery--nms-delivery-

Esse serviço permite criar e enviar uma ação de delivery.

Os seguintes parâmetros são necessários para chamar o serviço:

  • uma autenticação,
  • nome interno do template do delivery,
  • um documento XML opcional contendo dados adicionais de delivery.

Essa API não deve ser chamada no volume, pois pode haver problemas de desempenho.

Descrição do método no schema:

<method name="SubmitDelivery" static="true">
  <parameters>
    <param name="scenarioName" type="string" inout="in" desc="Internal name of the delivery template"/>
    <param name="content" type="DOMElement"  inout="in" desc="XML content of the delivery template" />
  </parameters>
</method>

Um template do delivery deve ser criado no console do cliente do Adobe Campaign. Ele contém os parâmetros comuns a todos os deliveries (endereço do remetente ou duração da validade da mensagem).

O documento XML de entrada é um fragmento de template de delivery que obedece à estrutura do schema "nms:delivery". Ele conterá todos os dados adicionais que não puderam ser definidos estaticamente no template do delivery (por exemplo, lista de recipients ao target).

Esta chamada não retorna dados, exceto erros.

Exemplo de documento XML xml-document-example

Este exemplo é baseado em um template de delivery personalizado de uma fonte de dados externa (um arquivo nesse caso). A configuração é totalmente descrita no template do delivery, de modo que tudo o que falta enviar quando a chamada ocorre é o conteúdo do arquivo do <externalsource> elemento.

<delivery>
  <targets fromExternalSource="true">
    <externalSource>
      MsgId|ClientId|Title|Name|FirstName| Mobile|Email| Market_segment|Product_affinity1 |Product_affinity2|Product_affinity3| Product_affinity4| Support_Number|Amount|Threshold1|000001234|M.| Doe|John|0650201020| john.doe@adobe.com
|1| A1|A2|A3|A4|E12|120000|100000
    </externalSource>
  </target>
</delivery>

Se você não tiver um template do delivery, poderá usar o seguinte exemplo:

<delivery>
<targets fromExternalSource="true" targetMode="1" noReconciliation="true" addressField="Email" >
    <fileFormat active="true">
      <source format="text" type="text">
        <dataSourceConfig >
          <dataSourceColumn label="Email" name="Email" type="string"/>
        </dataSourceConfig>
      </source>
      <destination type="xtkDataStore"/>
    </fileFormat>
    <externalSource><![CDATA[not-a-repicipient@domain.com]]></externalSource>
  </targets>
</delivery>
recommendation-more-help
601d79c3-e613-4db3-889a-ae959cd9e3e1