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

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

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

 


リクエストについて

サンプルはこちら

  • 文字コード: utf-8
  • APIのURL : https://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', #内容を示すURL(任意)
  :"def_action[influx_source_name]" => 'LP',#流入元(必須)最大64文字
  :"def_action[influx_source_url]" => 'URL', #流入元を示すURL(任意)
  :"def_action[defined_score]" => 100, #スコア(必須)-1000 ~ 1000 の値
#  customer_hashcode: '97db4ff1e78b9328', #カスタマーのhashcode(customer_emailを指定しない場合必須)
  customer_email: 'sample@satori.team', #カスタマーのemail(customer_hashcodeを指定しない場合必須)

レスポンスについて

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

管理画面での確認

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