Bedrijfsgerichte API’s business-oriented-apis

Bedrijfs-API is specifiek voor elk type object. Zij hebben een effect op:

In deze sectie wordt het gebruik van de services "Abonneren", "Unsubscribe" en "VerzendenLevering" beschreven.

Abonneren (nms:abonnement) subscribe--nms-subscription-

Met deze service kunt u een ontvanger abonneren op een informatieservice en het profiel van de ontvanger bijwerken.

De volgende parameters worden vereist om de dienst te roepen:

Beschrijving van de methode "subscribe" in het 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>

De definitie van de afstemmingssleutel moet worden ingevoerd via de _​ key kenmerk op de <recipient> -element van het XML-document. De inhoud van dit kenmerk is een XPath-lijst met komma's als scheidingsteken.

Deze aanroep retourneert geen gegevens, behalve fouten.

Voorbeelden examples

Abonnement met afstemmingssleutel voor ontvangers op het e-mailadres: het XML-invoerdocument moet verwijzen naar het e-mailadres en de definitie van de sleutel in dit veld.

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

De ontvanger en het abonnement bijwerken.

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

Voorbeeld van SOAP-berichten example-of-soap-messages

Abonnement opzeggen (nms:abonnement) unsubscribe--nms-subscription-

Met deze service kunt u het abonnement van een ontvanger op een informatieservice opzeggen en het profiel van de ontvanger bijwerken.

De volgende parameters worden vereist om de dienst te roepen:

Beschrijving van de methode "Unsubscribe" in het 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>

De definitie van de afstemmingssleutel moet worden ingevoerd via het _key-kenmerk op het tabblad <recipient> -element van het XML-document. De inhoud van dit kenmerk is een XPath-lijst met komma's als scheidingsteken.

Als de ontvanger niet aanwezig in het gegevensbestand is of niet aan de betrokken informatiedienst geabonneerd, voert de dienst geen actie uit en produceert geen fout.

Deze aanroep retourneert geen gegevens, behalve fouten.

Voorbeeld van SOAP-berichten example-of-soap-messages-1

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: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>

Reactie:

<?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>

VerzendenAflevering (nms:aflevering) submitdelivery--nms-delivery-

Met deze service kunt u een leveringsactie maken en verzenden.

De volgende parameters worden vereist om de dienst te roepen:

Deze API mag niet in volume worden aangeroepen omdat er mogelijk prestatieproblemen optreden.

Beschrijving van de methode in het 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>

Er moet een leveringssjabloon worden gemaakt vanaf de Adobe Campaign-clientconsole. Het bevat de parameters gemeenschappelijk voor alle leveringen (het adres van de afzender of de duur van de geldigheid van het bericht).

Het invoerXML-document is een leveringssjabloonfragment dat voldoet aan de structuur van het schema "nms:delivery". Het zal alle extra gegevens bevatten die niet statisch in het leveringsmalplaatje (b.v., lijst van ontvangers aan doel) konden worden bepaald.

Deze aanroep retourneert geen gegevens, behalve fouten.

Voorbeeld van XML-document xml-document-example

Dit voorbeeld is gebaseerd op een aangepaste leveringssjabloon van een externe gegevensbron (in dit geval een bestand). De configuratie wordt volledig beschreven in het leveringsmalplaatje, zodat alles dat moet worden verzonden wanneer de vraag voorkomt is de inhoud van het dossier van het <externalsource> element.

<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>

Als u geen leveringsmalplaatje hebt, kunt u het volgende voorbeeld gebruiken:

<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>