カスタマーアクション追加API

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

API連携はサーバーサイドスクリプトのプログラム開発が必要になるため、一定のWeb技術の知識が必要となります。
SATORI APIを利用した貴社システム側との連携方法や実装支援などはサポート範囲外とさせていただいており、
API連携に関してお伝えできる情報としましては、以下マニュアルに掲載されている情報のみとなります。
また、運用開始後にうまく連携されない場合のエラー解析やデバッグ対応についてもサポート範囲外となります。
技術的な知識を有している担当者様、もしくは連携先APIの仕様を理解されている担当者様に相談のうえ実装をご検討ください。

カスタマーアクション追加APIとは

カスタマーアクション追加APIでは、カスタマー詳細画面に表示される最新アクション一覧に、任意のアクションを追加しスコアを設定することが可能です。

リクエストについて

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

cURLリクエストサンプル

curl -X POST \
     -d "user_key=<ユーザーアクセスキー>" \
     -d "user_secret=<ユーザーシークレットキー>" \
     -d "company_key=<カンパニーアクセスキー>" \
     -d "company_secret=<カンパニーシークレットキー>" \
     -d "def_action[category]=資料" \
     -d "def_action[action_type_name]=ダウンロード" \
     -d "def_action[content_name]=商品資料" \
     -d "def_action[content_url]=https://example.com" \
     -d "def_action[influx_source_name]=LP" \
     -d "def_action[influx_source_url]=https://example.com" \
     -d "def_action[defined_score]=999" \
     -d "customer_email=<カスタマーのemail>" \
     https://api.satr.jp/api/v1/public/customers/add_action.json

レスポンスについて

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

  成功
  {"status"=>200, "message"=>"ok"}

  失敗（カスタマーが存在しないか、hashcodeまたはemailが指定されていない場合）
  {"status"=>400, "message"=>"customer not found."}

  失敗（必須がない場合）
  {"status"=>400, "message"=>["「必須項目」を入力してください。", "「必須項目」は1文字以上64文字以内で入力してください。"]}

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

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

管理画面での確認

登録に成功した場合、対象カスタマーの詳細画面にて、最新カスタマーアクションに追加されれます。

注意事項

カスタマーアクション追加APIを通じて渡されたスコア値については、スコア定義は無視されます。
※スコア定義については以下のマニュアルをご参照ください。
「スコア定義」について