シナリオの作成・管理

【シナリオエディタ】外部連携API

外部連携APIについて

「外部連携API」のパーツを設定することで、外部サービスとAPI連携をすることができます。
現在、talkmationがAPI連携をすることができる外部サービスは以下です。

  • ecforce
  • LINE LIFF

「外部連携API」のパーツを配置する

「外部連携API」のパーツをドラッグします。

content_013_01.jpg

エディタ内にドロップすると、【API追加】画面が表示されます。

content_013_02.jpg

項目 説明
サービスタイプ サービスタイプを設定できます。
サービス API連携をする外部サービス名を設定できます。
API APIの種類を設定できます。
設定できるAPIは以下です。

<ecforce>
<LINE LIFF>

設定が完了したら、「追加する」をクリックします。

content_013_03.jpg

「追加する」をクリックすると、APIの設定画面が表示されます。
設定が完了したら、「設定する」をクリックします。
※APIの設定方法については、各種APIの設定方法についてをご参照ください。

content_013_04.jpg

「外部連携API」のパーツが配置されます。

content_013_05.jpg

各種APIの設定方法について

各種APIの内容や設定方法についてご案内します。

ecforce MultiPass API

ecforce MultiPass APIは、すでにecforceにログインしているユーザーをtalkmation上でもログインしている状態にするAPIです。

注意点

ecforce MultiPass APIは、ショップページでのみ利用可能です。

【ecforce MultiPass API】画面にて、以下のように設定をしてください。

screenshot-talkmation.com-2021.10.08-19_31_14_____.png

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
シークレットキー ecforceのMultiPass シークレットキーを設定してください。
※ MultiPass シークレットキーは、ecforce管理画面の【設定を変更する > 外部連携アカウント > MultiPass(API)】画面にてご確認ください。
メールアドレス 「追加リクエストパラメーター」を用いて、ecforceから渡されるメールアドレスを設定してください。
※ 設定方法については、「追加リクエストパラメーター」の設定方法をご参照ください。
メールアドレスハッシュ値 「追加リクエストパラメーター」を用いて、ecforceから渡されるメールアドレスハッシュ値を設定してください。
※ 設定方法については、「追加リクエストパラメーター」の設定方法をご参照ください。

「追加リクエストパラメーター」の設定方法

【ecforce MultiPass API】画面にて、項目「メールアドレス」(もしくは、項目「メールアドレスハッシュ値」)のプルダウンをクリックしてください。

content_013_30.jpg

プルダウンをクリックすると、設定できる変数の一覧が表示されます。変数の一覧から「追加リクエストパラメータ」を選択してください。

content_013_31.jpg

「追加リクエストパラメータ」を選択した後、「設定」をクリックしてください。

content_013_32.jpg

「設定」をクリックすると、左側の欄に「{{request_params.ここに任意のパラメータ名を入れる}}」が入力されます。「ここに任意のパラメータ名を入れる」の箇所を任意のパラメータ名に書き換えてください。

content_013_27.jpg

パラメータ名を書き換えたら、「設定する」をクリックします。

content_013_28.jpg

なお、ecforce MultiPass APIを使用する場合、ユーザーのメールアドレスとメールアドレスハッシュ値がecforceから連携されるように設定する必要があります。
ecforce管理画面の「ページ管理」、「タグ管理」、「テーマ管理」のいずれかに以下の記述をしてください。

<script type='text/javascript' data-talkmation='1' data-talkmation-init-state='' src='https://talkmation.com/scenario/assets/tag.js' async></script>
<script type="text/javascript">
window.addEventListener("load", function () {
localStorage.clear();
TM_JS.setAddParams({
"項目「メールアドレス」で設定した任意のパラメータ名": Constants.email
, "項目「メールアドレスのハッシュ値」で設定したパラメータ名": Constants.hashed_email_for_multi_pass
});
TM_JS.load('シナリオコード', 'visible');
});
</script>

▼記述例(ecforce管理画面の「ページ管理」に記述)
content_013_68.jpg

 

ecforce MultiPass APIの選択肢は以下です。

項目 説明
成功 ecforceへのログインに成功した場合の選択肢です。
失敗 ecforceへのログインに失敗した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce LINE MultiPass API

ecforce LINE MultiPass APIは、LINE LIFF プロフィール情報取得APIで取得したユーザーのLINE IDもしくはメールアドレスを用いて、talkmation上でecforceにログインしている状態にするAPIです。

注意点

ecforce LINE MultiPass APIを使用する場合、ユーザーのLINEのプロフィール情報(LINE IDとメールアドレス)が必要になるため、予めLINE LIFF プロフィール情報取得APIが叩かれている必要があります。

【ecforce MultiPass API】画面にて、以下のように設定をしてください。

content_013_62.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
認証トークン ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。
※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。
シークレットキー ecforceのMultiPass シークレットキーを設定してください。
※ MultiPass シークレットキーは、ecforce管理画面の【設定を変更する > 外部連携アカウント > MultiPass(API)】画面にてご確認ください。
LINE ID 右側のプルダウンから「プロフィール情報取得(LINE LIFF - チャット)」の「LINE ID[sub]」を選択して「設定」をクリックしてください。
LINEメールアドレス 右側のプルダウンから「プロフィール情報取得(LINE LIFF - チャット)」の「メールアドレス[email]」を選択して「設定」をクリックしてください。

ecforce LINE MultiPass APIの選択肢は以下です。

項目 説明
成功 ecforceへのログインに成功した場合の選択肢です。
失敗 ecforceへのログインに失敗した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce ログインAPI

ecforce ログインAPIは、ユーザーがフォームに入力したecforceのログイン情報(メールアドレスとパスワード)を用いて、ユーザーをecforceにログインしている状態にするAPIです。

注意点

ecforce ログインAPIを使用する場合、ユーザーのecforceのログイン情報(メールアドレスとパスワード)が必要になるため、応答タイプが「フォーム」の対話ノードを予め設定しておく必要があります。

content_013_07.jpg

【ecforce ログインAPI】画面にて、以下のように設定をしてください。

content_013_06.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
メールアドレス フォームの「メールアドレス」を設定してください。
パスワード フォームの「パスワード」を設定してください。

ecforce ログインAPIの選択肢は以下です。

項目 説明
成功 ecforceへのログインに成功した場合の選択肢です。
失敗 ecforceへのログインに失敗した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 顧客詳細API

ecforce 顧客詳細APIは、ecforceに登録されているユーザー情報の詳細を取得するAPIです。

【ecforce 顧客詳細API】画面にて、以下のように設定をしてください。

content_013_09.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。

ecforce 顧客詳細APIの選択肢は以下です。

項目 説明
成功 ユーザーの情報取得に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 顧客メモ登録API

ecforce 顧客メモ登録APIは、ecforceの顧客メモを登録するAPIです。

【ecforce 顧客メモ登録API】画面にて、以下のように設定をしてください。

content_013_51.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
メモ ecforceの顧客メモに登録したい内容を設定してください。
※下側のプルダウンから変数を選択して設定することができます。
受付者メンバーID ecforceのメンバーIDを設定してください。

ecforce 顧客メモ登録APIの選択肢は以下です。

項目 説明
成功 顧客メモの登録に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期一覧API

ecforce 定期一覧APIは、ユーザーが契約しているステータスが「有効」の定期情報を取得するAPIです。
ユーザーが複数の定期を契約している場合、定期の一覧をプルダウンで表示させ、ユーザーに定期を選択させることができます。

【ecforce 定期一覧API】画面にて、以下のように設定をしてください。

content_013_56.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
SKU ID 特定の商品の定期を取得したい場合のみ、商品のSKU IDを設定してください。
定期選択メッセージ ユーザーが複数の定期を契約している場合、メッセージを表示することができます。
表示させたいメッセージを設定してください。

content_013_12.jpg
項目名 ユーザーが複数の定期を契約している場合、「選択方式」で設定した方式で定期の一覧が表示されます。
プルダウンの項目名として表示したいテキストを設定してください。

contnet_013_11.jpg
選択方式 ユーザーが複数の定期を契約している場合、ユーザーが定期を選択できます。
定期の選択方式を設定してください。
※「定期番号:[定期番号][定期に設定されている商品名])」の形式で表示されます。
・セレクトボックス
content_013_52.jpg
・ラジオ(カルーセル)
content_013_53.jpg

表示される画像について

定期に設定されている商品の画像(ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像)が表示されます。
定期に複数の商品が設定されている場合や商品に複数の画像が設定されている場合に表示される画像については、以下をご参照ください。
▼定期に複数の商品が設定されている場合
画像が設定されている1つ目の商品(ecforce管理画面の【受注管理 > 定期受注管理 > 該当定期の詳細】画面の「タブ:受注商品管理」で1番上に表示されている商品)の画像が表示されます。
▼商品に複数の画像が設定されている場合
ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ:画像管理」で1番上に表示されている画像が表示されます。

・ラジオ(テキスト)
content_013_54.jpg
・ラジオ(商品画像)
content_013_55.jpg

表示される画像について

定期に設定されている商品の画像(ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像)が表示されます。
定期に複数の商品が設定されている場合や商品に複数の画像が設定されている場合に表示される画像については、以下をご参照ください。
▼定期に複数の商品が設定されている場合
画像が設定されている1つ目の商品(ecforce管理画面の【受注管理 > 定期受注管理 > 該当定期の詳細】画面の「タブ:受注商品管理」で1番上に表示されている商品)の画像が表示されます。
▼商品に複数の画像が設定されている場合
ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ:画像管理」で1番上に表示されている画像が表示されます。

送信ボタンテキスト ユーザーが複数の定期を契約している場合、ユーザーが定期を選択できます。
情報を送信するボタンのテキストを設定してください。

content_013_13.jpg

ecforce 定期一覧APIの選択肢は以下です。

項目 説明
定期選択 ステータスが「有効」の定期情報の取得に成功した場合の選択肢です。
エラー (定期0件) ユーザーが、ステータスが「有効」の定期を1件も契約していない場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期商品詳細API

ecforce 定期商品詳細APIは、定期一覧APIで取得した定期に設定されている商品の詳細を取得するAPIです。定期に複数の商品が設定されている場合、商品の一覧をプルダウンで表示させ、ユーザーに商品を選択させることができます。

注意点

ecforce 定期商品詳細APIを使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。

 

【ecforce 定期商品詳細API】画面にて、以下のように設定をしてください。

content_013_39.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
SKU ID 特定の商品の詳細を取得したい場合のみ、商品のSKU IDを設定してください。
※SKU IDは複数設定できます(上限なし)。複数のSKU IDを設定する場合は、改行区切りで設定してください。
定期商品選択メッセージ 定期に複数の商品が設定されている場合、メッセージを表示することができます。
表示させたいメッセージを設定してください。

content_013_15.jpg
項目名 定期に複数の商品が設定されている場合、「選択方式」で設定した方式で商品の一覧が表示されます。
項目名として表示したいテキストを設定してください。

content_013_16.jpg
選択方式 定期に複数の商品が設定されている場合、ユーザーが商品を選択できます。
商品の選択方式を設定してください。
・セレクトボックス
content_013_40.jpg
・ラジオ(カルーセル)
content_013_41.jpg

表示される画像について

ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像が表示されます。
商品に複数の画像が設定されている場合は、ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ:画像管理」で1番上に表示されている画像が表示されます。

・ラジオ(テキスト)
content_013_42.jpg
・ラジオ(商品画像)
content_013_38.jpg

表示される画像について

ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像が表示されます。
商品に複数の画像が設定されている場合は、ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ:画像管理」で1番上に表示されている画像が表示されます。

送信ボタンテキスト 定期に複数の商品が設定されている場合、ユーザーが商品を選択できます。
情報を送信するボタンのテキストを設定してください。

content_013_17.jpg


ecforce 定期商品詳細APIの選択肢は以下です。

項目 説明
商品選択 定期に設定されている商品の詳細の取得に成功した場合の選択肢です。
エラー (商品0件) 定期に商品が1つも設定されていない場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期商品変更可能商品一覧API

ecforce 定期商品変更可能商品一覧APIは、定期の商品に設定されている変更可能商品(変更可能SKUグループ内の商品)を取得するAPIです。

注意点

ecforce 定期商品変更可能商品一覧APIを使用する場合、予めecforce 定期商品詳細APIが叩かれている必要があります。
また、ecforce管理画面にて以下の設定がされている必要があります。
・定期商品の変更:許可する
・SKUグループの設定
※詳細は、マイページで変更可能な商品は管理画面のどこで設定できますか?をご参照ください。

【ecforce 定期商品変更可能商品一覧API】画面にて、以下のように設定をしてください。

content_013_37.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
商品選択メッセージ チャットで表示させるメッセージを設定してください。

content_013_19.jpg
項目名 プルダウンの項目名として表示したいテキストを設定してください。

content_013_20.jpg
選択方式 商品の選択方式を設定してください。
・セレクトボックス
content_013_43.jpg
・ラジオ(カルーセル)
content_013_44.jpg
・ラジオ(テキスト)
content_013_45.jpg
・ラジオ(商品画像)
content_013_46.jpg
送信ボタンテキスト 情報を送信するボタンのテキストを設定してください。

content_013_21.jpg

ecforce 定期商品変更可能商品一覧APIの選択肢は以下です。

項目 説明
商品選択 変更可能商品の取得に成功した場合の選択肢です。
エラー (変更可能商品なし) 変更可能商品がない場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期商品変更API

ecforce 定期商品変更APIは、ユーザーがもつ定期の商品を変更するAPIです。

注意点

ecforce 定期商品変更APIを使用する場合、予めecforce 定期商品詳細APIが叩かれている必要があります。
また、ecforce管理画面にて「定期商品の変更:許可する」と設定されている必要があります。
※詳細は、マイページ設定をご参照ください。

【ecforce 定期商品変更API】画面にて、以下のように設定をしてください。

content_013_22.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
変更後SKU ID 変更後の商品のSKU IDを設定してください。
定期商品変更可能商品一覧APIにてユーザーが選択した商品に変更をしたい場合は、右側のプルダウンから「定期商品変更可能商品一覧」の「SKU ID[id]」を選択して「設定」をクリックしてください。
個数 変更後の商品の個数を設定してください。
変更前の商品の個数と同じにしたい場合は、右側のプルダウンから「定期商品詳細」の「個数[quantity]」を選択して「設定」をクリックしてください。

ecforce 定期商品変更APIの選択肢は以下です。

項目 説明
成功 商品の変更に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期配送スキップAPI

ecforce 定期配送スキップAPIは、定期の配送をスキップするAPIです。

注意点

ecforce 定期配送スキップAPIを使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて「次回配送のスキップ:許可する」と設定されている必要があります。
※詳細は、マイページ設定をご参照ください。

【ecforce 定期配送スキップAPI】画面にて、以下のように設定をしてください。

content_013_23.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。

ecforce 定期配送スキップAPIの選択肢は以下です。

項目 説明
成功 配送スキップに成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期配送サイクル取得API

ecforce 定期配送サイクル取得APIは、定期に設定されている商品の配送サイクルを取得するAPIです。

注意点

ecforce 定期配送サイクル取得APIを使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。

【ecforce 定期配送サイクル取得API】画面にて、以下のように設定をしてください。

content_013_59.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
配送サイクル選択メッセージ 表示させたいメッセージを設定してください。

content_013_66.jpg
送信ボタンテキスト 情報を送信するボタンのテキストを設定してください。

content_013_67.jpg

ecforce 定期配送スキップAPIの選択肢は以下です。

項目 説明
成功 配送サイクルの取得に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期配送サイクル変更API

ecforce 定期配送サイクル変更APIは、定期の配送サイクルを変更するAPIです。

注意点

ecforce 定期配送サイクル変更APIを使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて「定期配送サイクルの変更:許可する」と設定されている必要があります。
※詳細は、マイページ設定をご参照ください。

【ecforce 定期配送サイクル変更API】画面にて、以下のように設定をしてください。

content_013_60.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
配送サイクル 変更後の配送サイクルを設定してください。
定期配送サイクル取得APIでユーザーが選択した配送サイクルを設定したい場合は、右側のプルダウンから「定期配送サイクル取得」の「配送サイクル[payment_schedule]」を選択して「設定」をクリックしてください。
何ヶ月ごと 配送サイクルに「date」もしくは「day_of_week」を設定した場合、本項目は必ず設定してください。
定期配送サイクル取得APIでユーザーが選択した配送サイクルを設定したい場合は、右側のプルダウンから「定期配送サイクル取得」の「何ヶ月ごと[scheduled_to_be_delivered_every_x_month]」を選択して「設定」をクリックしてください。
何日に 配送サイクルに「date」を設定した場合、本項目は必ず設定してください。
定期配送サイクル取得APIでユーザーが選択した配送サイクルを設定したい場合は、右側のプルダウンから「定期配送サイクル取得」の「何日[scheduled_to_be_delivered_on_xth_day]」を選択して「設定」をクリックしてください。
何回目の 配送サイクルに「day_of_week」を設定した場合、本項目は必ず設定してください。
定期配送サイクル取得APIでユーザーが選択した配送サイクルを設定したい場合は、右側のプルダウンから「定期配送サイクル取得」の「何回目[scheduled_to_be_delivered_on_xth_day_of_week]」を選択して「設定」をクリックしてください。
何曜日に 配送サイクルに「day_of_week」を設定した場合、本項目は必ず設定してください。
定期配送サイクル取得APIでユーザーが選択した配送サイクルを設定したい場合は、右側のプルダウンから「定期配送サイクル取得」の「何曜日[scheduled_to_be_delivered_every_x_day_of_week]」を選択して「設定」をクリックしてください。
何日ごと 配送サイクルに「term」を設定した場合、本項目は必ず設定してください。
定期配送サイクル取得APIでユーザーが選択した配送サイクルを設定したい場合は、右側のプルダウンから「定期配送サイクル取得」の「何日ごと[scheduled_to_be_delivered_every_x_day]」を選択して「設定」をクリックしてください。

ecforce 定期配送サイクル変更APIの選択肢は以下です。

項目 説明
成功 配送サイクルの変更に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期停止API

ecforce 定期停止APIは、定期を停止するAPIです。
※マイページからの定期解約は許可せず、talkmationからの定期解約は許可する場合にご使用ください。

注意点

ecforce 定期停止APIを使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて「定期解約ステータス:停止」と設定されている必要があります。
※詳細は、マイページ設定をご参照ください。

【ecforce定期停止API】画面にて、以下のように設定をしてください。

content_013_57.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
認証トークン ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。
※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。
停止理由ID 停止理由IDを指定することで、定期受注に停止理由を設定することができます。
ecforceに登録されている、停止理由のIDを設定してください。
なお、定期受注停止理由取得APIでユーザーが選択した停止理由のIDを設定する場合は、右側のプルダウンから「定期受注停止理由取得」の「理由ID[id]」を選択して「設定」をクリックしてください。

ecforce 定期停止APIの選択肢は以下です。

項目 説明
成功 定期の停止に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期停止API(マイページ挙動)

ecforce 定期停止API(マイページ挙動)は、定期を停止するAPIです。

注意点

ecforce 定期停止API(マイページ挙動)を使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて以下の設定がされている必要があります。
・定期解約:許可する
・定期解約ステータス:停止
※詳細は、マイページ設定をご参照ください。

【ecforce定期停止API(マイページ挙動)】画面にて、以下のように設定をしてください。

content_013_64.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
停止理由ID 停止理由IDを指定することで、定期受注に停止理由を設定することができます。
ecforceに登録されている、親停止理由が「マイページからの停止」である停止理由のIDを設定してください。
なお、定期受注停止理由取得APIでユーザーが選択した停止理由のIDを設定する場合は、右側のプルダウンから「定期受注停止理由取得」の「理由ID[id]」を選択して「設定」をクリックしてください。
※親停止理由が「マイページからの停止」でない停止理由のIDが設定されていた場合、API実行時にエラーとなります。

ecforce 定期停止API(マイページ挙動)の選択肢は以下です。

項目 説明
成功 定期の停止に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期キャンセルAPI

ecforce 定期キャンセルAPIは、定期をキャンセルするAPIです。
※マイページからの定期キャンセルは許可せず、talkmationからの定期キャンセルは許可する場合にご使用ください。

注意点

ecforce 定期キャンセルAPIを使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて「定期解約ステータス:キャンセル」と設定されている必要があります。
※詳細は、マイページ設定をご参照ください。

【ecforce 定期キャンセルAPI】画面にて、以下のように設定をしてください。

content_013_58.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
認証トークン ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。
※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。
キャンセル理由ID キャンセル理由IDを指定することで、定期受注にキャンセル理由を設定することができます。
ecforceに登録されている、キャンセル理由のIDを設定してください。
なお、定期受注キャンセル理由取得APIでユーザーが選択したキャンセル理由のIDを設定する場合は、右側のプルダウンから「定期受注キャンセル理由取得」の「理由ID[id]」を選択して「設定」をクリックしてください。

ecforce 定期キャンセルAPIの選択肢は以下です。

項目 説明
成功 定期のキャンセルに成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期キャンセルAPI(マイページ挙動)

ecforce 定期キャンセルAPI(マイページ挙動)は、定期をキャンセルするAPIです。

注意点

ecforce 定期キャンセルAPI(マイページ挙動)を使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて以下の設定がされている必要があります。
・定期解約:許可する
・定期解約ステータス:キャンセル
※詳細は、マイページ設定をご参照ください。

【ecforce 定期キャンセルAPI(マイページ挙動)】画面にて、以下のように設定をしてください。

content_013_65.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
キャンセル理由ID キャンセル理由IDを指定することで、定期受注にキャンセル理由を設定することができます。
ecforceに登録されている、親キャンセル理由が「マイページからのキャンセル」であるキャンセル理由のIDを設定してください。
なお、定期受注キャンセル理由取得APIでユーザーが選択したキャンセル理由のIDを設定する場合は、右側のプルダウンから「定期受注キャンセル理由取得」の「理由ID[id]」を選択して「設定」をクリックしてください。
※親キャンセル理由が「マイページからのキャンセル」でないキャンセル理由のIDが設定されていた場合、API実行時にエラーとなります。

ecforce 定期キャンセルAPI(マイページ挙動)の選択肢は以下です。

項目 説明
成功 定期のキャンセルに成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期受注キャンセル理由取得API

ecforce 定期受注キャンセル理由取得APIは、ecforceに登録されているキャンセル理由を取得し、ユーザーにキャンセル理由を選択させることができるAPIです。

注意点

ecforce 定期キャンセルAPI(マイページ挙動)を使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて以下の設定がされている必要があります。
・定期解約ステータス:キャンセル
・定期解約理由の選択:有効
※詳細は、マイページ設定をご参照ください。

【ecforce 定期受注キャンセル理由取得API】画面にて、以下のように設定をしてください。

content_013_33.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
認証トークン ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。
※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。
親理由ID 親キャンセル理由に紐付いている子キャンセル理由のみを選択させたい場合、ecforceの「キャンセル理由管理」で作成した親キャンセル理由のIDを設定してください。
理由選択メッセージ ecforceに複数のキャンセル理由が設定されている、もしくは親キャンセル理由に複数の子キャンセル理由が設定されている場合、メッセージを表示することができます。
表示させたいメッセージを設定してください。

content_013_34.jpg
項目名 ecforceに複数のキャンセル理由が設定されている、もしくは親キャンセル理由に複数の子キャンセル理由が設定されている場合、キャンセル理由の一覧がプルダウンで表示されます。
プルダウンの項目名として表示したいテキストを設定してください。

content_013_35.jpg
送信ボタンテキスト ecforceに複数のキャンセル理由が設定されている、もしくは親キャンセル理由に複数の子キャンセル理由が設定されている場合、ユーザーがプルダウンからキャンセル理由を選択できます。
情報を送信するボタンのテキストを設定してください。

content_013_36.jpg

ecforce 定期受注キャンセル理由取得APIの選択肢は以下です。

項目 説明
成功 キャンセル理由の選択に成功した場合の選択肢です。
エラー (理由0個) ecforceにキャンセル理由が設定されていない、もしくは親キャンセル理由に子キャンセル理由が設定されていない場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 定期受注停止理由取得API

ecforce 定期受注停止理由取得APIは、ecforceに登録されている停止理由を取得し、ユーザーに停止理由を選択させることができるAPIです。

注意点

ecforce 定期キャンセルAPI(マイページ挙動)を使用する場合、予めecforce 定期一覧APIが叩かれている必要があります。
また、ecforce管理画面にて以下の設定がされている必要があります。
・定期解約ステータス:停止
・定期解約理由の選択:有効
※詳細は、マイページ設定をご参照ください。

【ecforce 定期受注停止理由取得API】画面にて、以下のように設定をしてください。

content_013_47.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
認証トークン ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。
※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。
親理由ID 親停止理由に紐付いている子停止理由のみを選択させたい場合、ecforceの「停止理由管理」で作成した親停止理由のIDを設定してください。
理由選択メッセージ ecforceに複数の停止理由が設定されている、もしくは親停止理由に複数の子停止理由が設定されている場合、メッセージを表示することができます。
表示させたいメッセージを設定してください。

content_013_48.jpg
項目名 ecforceに複数の停止理由が設定されている、もしくは親停止理由に複数の子停止理由が設定されている場合、停止理由の一覧がプルダウンで表示されます。
プルダウンの項目名として表示したいテキストを設定してください。

content_013_49.jpg
送信ボタンテキスト ecforceに複数の停止理由が設定されている、もしくは親停止理由に複数の子停止理由が設定されている場合、ユーザーがプルダウンから停止理由を選択できます。
情報を送信するボタンのテキストを設定してください。

content_013_50.jpg

ecforce 定期受注停止理由取得APIの選択肢は以下です。

項目 説明
成功 停止理由の選択に成功した場合の選択肢です。
エラー (理由0個) ecforceに停止理由が設定されていない、もしくは親停止理由に子停止理由が設定されていない場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

ecforce 顧客LINE ID更新API

ecforce 顧客LINE ID更新APIは、LINE LIFF プロフィール情報取得APIで取得したユーザーのLINE IDをecforce上のユーザーのLINE IDとして登録(更新)するAPIです。

注意点

ecforce 顧客LINE ID更新APIを使用する場合、ユーザーのLINEのプロフィール情報(LINE ID)が必要になるため、予めLINE LIFF プロフィール情報取得APIが叩かれている必要があります。

【ecforce 顧客LINE ID更新API】画面にて、以下のように設定をしてください。

content_013_63.jpg

項目 説明
API URLスキーム 「https」と設定してください。
APIドメイン ecforceのAPI接続用URLのドメインを設定してください。
LINE ID 右側のプルダウンから「プロフィール情報取得(LINE LIFF - チャット)」の「LINE ID[sub]」を選択して「設定」をクリックしてください。

ecforce 顧客LINE ID更新APIの選択肢は以下です。

項目 説明
成功 LINE IDの更新に成功した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

 

LINE LIFF プロフィール情報取得API

LINE LIFF プロフィール情報取得APIは、ユーザーのLINEのプロフィール(ユーザーID、表示名、プロフィール画像、メールアドレス)を取得するAPIです。

【LINE LIFF プロフィール情報取得API】画面にて、以下のように設定をしてください。

content_013_61.jpg

項目 説明
チャネルID LINE Developersコンソールで作成したチャネルのチャネルIDを設定してください。
※チャネルIDは、LINE Developersコンソールの[チャネル基本設定]タブで確認することができます。
IDトークン 右側のプルダウンから「LINE LIFF定数」の「ID Token」を選択して「設定」をクリックしてください。

LINE LIFF プロフィール情報取得APIの選択肢は以下です。

項目 説明
成功 プロフィール情報の取得に成功した場合の選択肢です。
失敗 プロフィール情報の取得に失敗した場合の選択肢です。
IDトークンなし LINE以外からtalkmationを起動した場合の選択肢です。
エラー (API) エラーが発生した場合の選択肢です。

この記事の目次

このセクションの記事

シナリオの作成・管理