カスタマーアクション追加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
  • 送信するパラメータリスト
パラメータ名 日本語名 必須 備考
user_key ユーザー
アクセスキー
管理画面より取得
user_secret ユーザー
シークレットキー
管理画面より取得
company_key カンパニー
アクセスキー
管理画面より取得
company_secret カンパニー
シークレットキー
管理画面より取得
def_action[category] アクションカテゴリ 最大64文字
def_action[action_type_name] アクションタイプ 最大64文字
def_action[content_name] 内容 - 最大64文字
def_action[content_url] 内容を示すURL - 最大255文字
def_action[influx_source_name] 流入元 最大64文字
def_action[influx_source_url] 流入元URL - 最大255文字
def_action[defined_score] スコア -1000 ~ 1000の値
customer_email カスタマーのemail customer_hashcodeを指定しない場合必須
customer_hashcode カスタマーのhashcode customer_emailを指定しない場合必須

 

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

 


管理画面での確認

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