2.APIコールとメソッドリファレンス

• APIコール
  • 各項目の説明
• APIメソッドリファレンス
  • WSDLファイルの取得方法

APIコール

認証トークンおよび認証ユーザトークンを取得後、取得したトークンを使ってAPIコールを行います。 APIコールは、以下の形式でHTTPリクエストします。

各項目の説明

凡例	内容
{domainname}	お客様のドメイン名（例：shanon.smartseminar.jp）です。 実際には{domainname}の部分を以下のように読み替えて使用します。 https://{domainname}/services/rest/authinfo/token ↓ https://shanon.smartseminar.jp/services/rest/authinfo/token
{path}	APIへのアクセスURLパスです。 マーケティングプラットフォームで使用可能なアクセスURLは、APIメソッドリファレンスの「APIサービス一覧」をご参照ください。 例：リード情報APIのアクセスURLパス /services/rest/visitor
{parameter}	APIに渡すパラメータです。パラメータに以下の種類があります。 ・検索条件指定パラメータ ・並び順指定パラメータ ・取得件数指定パラメータ ・認証トークン ・認証ユーザトークン ・シグネチャ ・キャンペーン申込用パラメータ ※認証トークン、認証ユーザトークン、シグネチャについては、前述の「認証トークン」、「ユーザ認証トークン」を参照ください。 ※キャンペーン申込用パラメータは、「APIによるキャンペーンの申込について」を参照ください。

APIコールのHTTPリクエストサンプル

APIメソッドリファレンス

マーケティングプラットフォームAPIのメソッドリファレンスです。 各APIで必要なリクエスト項目およびレスポンス内容を記載します。 詳細なデータ型は、WSDLファイルを参照ください。

WSDLファイルの取得方法

各APIの定義はWSDLファイルに記載されています。 WSDLファイルは、以下の手順で取得します。

1. マーケティングプラットフォームの管理画面にログインします。
2. [全キャンペーン管理モード] （青色の画面）にて [設定]タブをクリックします。
3. メニューの[API]をクリックし、APIキー管理画面に遷移します。
4. [API定義のダウンロード] ボタンをクリックします。

WSDL ファイルの更新タイミング

WSDL は以下の場合に更新されます。

1. API のバージョンアップ
2. 追加項目/設問の更新

<例> - 活動履歴 - アンケート - キャンペーン - サブキャンペーン - 講演者 - リード #### 凡例 |凡例|内容| | ----- | ----- | |{domainname}|お客様のドメイン名（例：shanon.smartseminar.jp）です。
実際には {domainname} の部分を以下のように読み替えて使用します。
https://{domainname}/services/rest/authinfo/token
↓
https://shanon.smartseminar.jp/services/rest/authinfo/token| |{id}|APIで対象とするエレメントのIDを表します。
実際には、 {id} の部分を以下のように読み替えて使用します。
/{id} → /1| |search_key{cid}
search_operator{cid}
search_value{cid}|検索条件指定パラメータのIDを表します。
実際には{cid}の部分を一意の数値に読み替えて使用します。

search_key{cid} → search_key1

※詳細は、下記「検索条件指定パラメータ」参照| |Attribute{aid}|追加項目のIDを表します。
実際には、 {aid} の部分を以下のように読み替えて使用します。

Attribute{aid} → Attribute1

検索条件への設定方法に関しましては上記の章「APIコール」の節
「検索条件への指定方法」を参照ください| |GET|HTTPリクエストメソッドのうち、GET メソッドを表します。
GETメソッドは、URLで識別されるリソースを取得することを要求します。（一覧表示、詳細表示、検索など）
フォームの入力データは、URLの一部(URL部パラメータ)として送信します。| |POST|HTTPリクエストメソッドのうち、POST メソッドを表します。
POSTメソッドは、URLで識別されるリソースに対し、新規にデータを登録することを要求します。（新規登録）

フォームの入力データは、メッセージボディ(HTTPリクエストボディ)に格納して送信します。| |PUT|HTTPリクエストメソッドのうち、PUT メソッドを表します。
PUT メソッドは、URLで識別されるリソースに対し、入力データの内容で修正することを要求します。（更新）

フォームの入力データは、メッセージボディ（HTTPリクエストボディ）に格納して送信します。

※マーケティングプラットフォームAPIにてPUTメソッドを使用する場合は、リクエストヘッダ（HTTPリクエストヘッダ）に
X-HTTP-Method-Override:PUTを記載してください。| |DELETE|HTTPリクエストメソッドのうち、DELETE メソッドを表します。
DELETEメソッドは、URLで識別されるリソースを削除することを要求します。（削除）

※マーケティングプラットフォームAPIにてDELETEメソッドを使用する場合は、リクエストヘッダ(HTTPリクエストヘッダ)にX-HTTP-Method-Override:DELETEを記載してください|