【旧バージョン】APIバージョン3の利用方法（カスタマー新規登録・更新・削除）

2021/11/11のUI刷新 第一弾リリースにてカラースキーム(配色設計)とタイポグラフィ(文字の書体、大きさ、配列のしかたなど)を変更しております。オンラインマニュアルに掲載している画面キャプチャと実際の管理画面の配色や文字の状態が異なる場合がございますがご了承いただけますと幸いでございます。

注意事項

外部フォームからSATORIへカスタマー登録をするための目的で公開しているAPIです。
大量なリクエストを必要とするようなカスタマー情報の同期など、意図しない目的でのご利用はご遠慮ください。

また、カレント以外のバージョンは非推奨になっています。

 ※API最新バージョンは「APIバージョン4」でございます。
本ページに記載している「APIバージョン3」につきましては旧APIとなり、バージョン4への移行作業をお願いしております。
詳細については「APIバージョン4の利用方法」をご確認くださいませ。

前提事項

バージョン3では以下の3種類のAPIが提供されます。

• 新規登録用： registration.json
• 新規登録および更新用： upsert.json
• 削除用： delete.json

それぞれ、サンプルを元に解説します。

バージョン3では、任意のパラメータを送付することができ、その内容を管理画面からご確認いただくことが可能です。詳細はこのページ下部の「管理画面での確認」項目をご確認ください。

管理画面から取得する項目

下記の項目は管理画面より取得してください。

• user_key: 'ユーザーアクセスキー', #（管理画面より取得）
• user_secret: 'ユーザーシークレットキー', #（管理画面より取得）
• company_key: 'カンパニーアクセスキー', #（管理画面より取得）
• company_secret: 'カンパニーシークレットキー', #（管理画面より取得）

取得方法はこちらをご参照ください。

新規登録用： registration.json

registration.json での更新可能項目

• タグの追加
• メール配信可否、スター、ステータスの変更
• 空欄項目への追加（既に登録がある場合、更新できません） 

リクエストについて

• Content-Type： application/x-www-form-urlencoded
• 文字コード： UTF-8
• APIのURL： https://api.satr.jp/api/v3/public/customer/registration.json
• 送信するパラメータリスト

cURLリクエストサンプル

curl -X POST \
     -d "user_key=<ユーザーアクセスキー>" \
     -d "user_secret=<ユーザーシークレットキー>" \
     -d "company_key=<カンパニーアクセスキー>" \
     -d "company_secret=<カンパニーシークレットキー>" \
     -d "customer[identity_type]=email" \
     -d "customer[email]=<メールアドレス>" \
     -d "customer[collection_route]=<情報獲得経路>" \
     https://api.satr.jp/api/v3/public/customer/registration.json

新規登録および更新用： upsert.json

upsert.json の動作

指定したemailまたはhashcodeが存在していない場合には新規登録、存在している場合は更新になります。

リクエストについて

• Content-Type： application/x-www-form-urlencoded
• 文字コード： UTF-8
• APIのURL： https://api.satr.jp/api/v3/public/customer/upsert.json
• 送信するパラメータリスト

cURLリクエストサンプル

curl -X POST \
     -d "user_key=<ユーザーアクセスキー>" \
     -d "user_secret=<ユーザーシークレットキー>" \
     -d "company_key=<カンパニーアクセスキー>" \
     -d "company_secret=<カンパニーシークレットキー>" \
     -d "customer[identity_type]=email" \
     -d "customer[email]=<メールアドレス>" \
     -d "customer[collection_route]=<情報獲得経路>" \
     https://api.satr.jp/api/v3/public/customer/upsert.json

削除用： delete.json

delete.json の動作

指定したemailまたはhashcodeのカスタマーが削除されます。

リクエストについて

• Content-Type： application/x-www-form-urlencoded
• 文字コード： UTF-8
• APIのURL： https://api.satr.jp/api/v3/public/customer/delete.json
• 送信するパラメータリスト

cURLリクエストサンプル

curl -X POST \
     -d "user_key=<ユーザーアクセスキー>" \
     -d "user_secret=<ユーザーシークレットキー>" \
     -d "company_key=<カンパニーアクセスキー>" \
     -d "company_secret=<カンパニーシークレットキー>" \
     -d "customer[identity_type]=email" \
     -d "customer[email]=<メールアドレス>" \
     https://api.satr.jp/api/v3/public/customer/delete.json

レスポンスについて

JSONフォーマットでレスポンスが返されます。
レスポンスは以下の種類があります。

  成功
  {"status":200, "message": {"customer[hashcode]": "8eced811cdb57f56"}}
  メールアドレスに対応したハッシュコードが返却されます。

  失敗（苗字なし）
  {"status":400, "message": "バリデーションに失敗しました。 苗字を入力してください。"}

  失敗（メールアドレスなし）
  {"status": 400, "message": "validation error: customer[email] required."}

  失敗（APIキー不正）
  {"status":401, "message": "Unauthorized"}

  失敗（その他）
  {"status": 409, "message": "Conflict"}

レスポンスの処理

成功した場合には次のいずれかの処理を追加することで、登録されたメールアドレスとブラウザ（Cookie）とを紐付けることができます。

  レスポンス内容 => {"status": 200, "message": {"customer[hashcode]": "8eced811cdb57f56"}}

・紐付け方法1
  返却されたhashcodeに-00を追加した値を、遷移先ページのcパラメータとして追加してください。
  遷移先ページにSATORI計測タグが設置されている必要があります。


  例：（会員登録完了のサンクスページを以下のようにしてください。）
  http://sample.com/thank_you?c=8eced811cdb57f56-00

・紐付け方法2
  返却されたhashcodeに-00を追加した値を使用して、遷移先ページに以下のJavaScriptを追加してください。 
　scriptタグ設置場所はSATORI計測タグの上になります。

 <script>
 var StDmp = {};
 StDmp.additionalParams = { c: "8eced811cdb57f56-00" };
 </script>

管理画面での確認

APIバージョン3では、登録または更新成功した場合、送信した内容を管理画面から確認することができます。

登録または更新を行ったカスタマー詳細画面の最新アクション一覧から、アクションが「API登録」になっているものの「内容」部分のリンクに遷移いただくことで、以下のように、送信内容を確認することができます。