Web 服務呼叫

最後更新： 2024年7月19日
  • 主題：
  • API

建立對象：

  • 開發人員

一般資訊

所有API方法都會以網站服務的形式呈現。 這可讓您透過SOAP呼叫管理所有Adobe Campaign功能，這是Adobe Campaign應用程式伺服器的原生入口點。 Adobe Campaign主控台本身只使用SOAP呼叫。

Web服務可讓您從協力廠商系統建立許多應用程式：

  • 來自後台或交易系統的同步警報、通知和即時傳遞範本執行，
  • 開發具有簡化功能的特殊介面（網頁介面等）；
  • 在觀察交易規則並維持與基礎實體模型隔離的狀態下，饋送及查詢資料庫中的資料。

Web服務的定義

在Adobe Campaign應用程式伺服器上實作的Web服務定義，可從資料結構描述取得。

Web服務在資料結構描述的文法中說明，並可從​ <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呼叫輸出處。

「static」屬性（值為「true」）的存在說明此方法為static，這表示方法的所有引數都必須宣告。

「const」方法隱含地以關聯結構描述格式的XML檔案作為其輸入。

在方法下的「結構描述參考」章節中，提供Adobe Campaign結構描述的<method>元素的完整說明

「xtk：queryDef」結構描述中的「const」型別「ExecuteQuery」方法範例：

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

此方法的輸入引數是採用「xtk：queryDef」結構描述格式的XML檔案。

Web服務說明：WSDL

每個服務都有WSDL （Web服務描述庫）檔案。 此XML檔案使用元語言來說明服務，並指定要連絡以執行服務的可用方法、引數及伺服器。

WSDL檔案產生

若要產生WSDL檔案，您必須從Web瀏覽器輸入下列URL：

https://<server>/nl/jsp/schemawsdl.jsp？schema=<schema>

替換為：

  • <server>： Adobe Campaign應用程式伺服器(nlserver web)
  • <schema>：結構描述識別金鑰(namespace：schema_name)

結構描述「xtk：queryDef」的「ExecuteQuery」方法範例

WSDL檔案是從URL產生：

https://localhost/nl/jsp/schemawsdl.jsp?schema=xtk:queryDef

WSDL說明首先會定義用來形成訊息的型別，這些訊息在「連線埠」中關聯，透過「連結」形成Web服務而連線到通訊協定。

類型

型別定義以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>

訊息

<message>說明要傳送的一組欄位的名稱和型別。 方法使用兩則訊息作為引數("ExecuteQueryIn")及傳回值("ExecuteQueryOut")來傳遞。

<message name="ExecuteQueryIn">
  <part element="tns:ExecuteQuery" name="parameters"/>
</message>

<message name="ExecuteQueryOut">
  <part element="tns:ExecuteQueryResponse" name="parameters"/>
</message>

連線埠型別

<porttype>會與由產生回應（「輸出」）的查詢（「輸入」）所觸發的「ExecuteQuery」作業上的訊息建立關聯。

<portType name="queryDefMethodsSoap">
  <operation name="ExecuteQuery">
    <input message="tns:ExecuteQueryIn"/>
    <output message="tns:ExecuteQueryOut"/>
  </operation>
</portType>

繫結

<binding>部分指定SOAP通訊協定( <soap:binding>)、HTTP中的資料傳輸（「傳輸」屬性的值）以及「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>部分說明「XtkQueryDef」服務，其URI位於Adobe Campaign應用程式伺服器的URL上。

<service name="XtkQueryDef">
  <port binding="tns:queryDefMethodsSoap" name="queryDefMethodsSoap">
    <soap:address location="https://localhost/nl/jsp/soaprouter.jsp"/>
  </port>
</service>