Home >> Bulkapi.index

一括登録情報API

一括登録API、一括登録結果取得APIを組み合わせてマーケティングプラットフォームへ一度に大量のデータを登録することができます。 ※一度に登録できる件数についてはAPIメソッドリファレンス「一括登録API」の制限事項をご参照ください。

一括登録API / 一括登録結果取得API の利用方法

前提条件

クライアントアプリケーション認証が行われている必要があります。
※クライアントアプリケーション認証についてはAPIメソッドリファレンス「クライアントアプリケーション認証API」をご参照ください。

利用方法

クライアントアプリケーション認証後に一括登録情報API を使用する場合の流れについて、シーケンス図を用いて解説します。クライアントアプリケーション認証後の一括登録情報API シーケンス図

(１)一括登録APIの呼び出し

リクエスト情報リクエストXMLにを一括登録Methodと一括登録を指定しますデータをルールに従い作成します。
※リクエストXMLのサンプルXML作成ルールについてはAPIメソッドリファレンス「一括登録API」を参照してください。

マーケティングプラットフォームAPIキー、認証トークン、シグネチャに必要な情報を付加してAPIコールします。
RESTで一括登録APIを呼び出すURLは以下です。

https://{domainname}/services/rest/bulkapi?api_key=[api_key]&token=[token]&api_sig=[api_sig]

・レスポンス情報
レスポンスヘッダーに含まれるLocation情報から{id}を取得します。
例）以下のようなレスポンスヘッダーの場合は「35」

HTTP/1.1 201 Created
Date: Wed, 15 Jul 2015 05:07:42 GMT
Server: Apache
Content-Length: 98
P3P: CP="STE TAI SAM"
Location: https://{domainname}/services/rest/bulkapi/35
Content-Type: text/xml
Set-Cookie: ss_session=ss0800c045e34224b80dfb6c6ebd4f52e1; path=/; secure
Set-Cookie: mp_session=cab4e1a3172b54810a8b92624e0ca9899c23210b; path=/; secure; HttpOnly
Strict-Transport-Security: max-age=315360000;

(２)一括登録結果取得APIで処理経過を確認

リクエスト情報
(１)で取得した{id}を利用して、マーケティングプラットフォームAPIキー、認証トークン、シグネチャに必要な情報を付加してAPIコールします。
RESTで一括登録結果取得APIを呼び出すURLは以下です。

https://{domainname}/services/rest/bulkapi?api_key=[api_key]&token=[token]&api_sig=[api_sig]&id=[(１)で取得した{id}]

レスポンス情報
一括登録の進捗状況を確認します。
ここでは、進捗状況のステータス（BulkStatus）を確認できます。
ステータス（BulkStatus）は以下のパターンの分類されます。

1：未実行
2：実行中
3：終了
4：異常終了

※レスポンス情報の詳細はAPIメソッドリファレンス「一括登録結果取得API」を参照ください。

ステータス監視レスポンス情報に含まれるステータス（BulkStatus）が「終了」もしくは「異常終了」になるまで(２)を繰り返し実行します。

(３)一括登録結果取得APIで処理結果を取得
一括登録APIのI処理結果を解析します。(２)のレスポンス情報に含まれるステータス（BulkStatus）が「終了」もしくは「異常終了」だった場合に処理結果を参照できます。
ここでは、データ毎にステータス（BulkResultStatus）を確認できます。
ステータス（BulkResultStatus）は以下のパターンに分類されます。

成功
エラー
未実行

※レスポンス情報の詳細はAPIメソッドリファレンス「一括登録結果取得一括登録API」を参照ください。