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

外部連携APIについて

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

• ecforce
• LINE LIFF

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

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

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

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

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

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

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

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

ecforce MultiPass API

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

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

<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 MultiPass APIの選択肢は以下です。

ecforce LINE MultiPass API

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

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

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

ecforce ログインAPI

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

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

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

ecforce 顧客詳細API

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

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

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

ecforce 顧客メモ登録API

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

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

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

ecforce 定期一覧API

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

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

項目	説明
API URLスキーム	「https」と設定してください。
APIドメイン	ecforceのAPI接続用URLのドメインを設定してください。
SKU ID	特定の商品の定期を取得したい場合のみ、商品のSKU IDを設定してください。
定期選択メッセージ	ユーザーが複数の定期を契約している場合、メッセージを表示することができます。 表示させたいメッセージを設定してください。
項目名	ユーザーが複数の定期を契約している場合、「選択方式」で設定した方式で定期の一覧が表示されます。 プルダウンの項目名として表示したいテキストを設定してください。
選択方式	ユーザーが複数の定期を契約している場合、ユーザーが定期を選択できます。 定期の選択方式を設定してください。 ※「定期番号:[定期番号]（[定期に設定されている商品名]）」の形式で表示されます。 ・セレクトボックス ・ラジオ（カルーセル） 表示される画像について 定期に設定されている商品の画像（ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ：画像管理」で設定した画像）が表示されます。 定期に複数の商品が設定されている場合や商品に複数の画像が設定されている場合に表示される画像については、以下をご参照ください。 ▼定期に複数の商品が設定されている場合 画像が設定されている1つ目の商品（ecforce管理画面の【受注管理 > 定期受注管理 > 該当定期の詳細】画面の「タブ：受注商品管理」で1番上に表示されている商品）の画像が表示されます。 ▼商品に複数の画像が設定されている場合 ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ：画像管理」で1番上に表示されている画像が表示されます。 ・ラジオ（テキスト） ・ラジオ（商品画像） 表示される画像について 定期に設定されている商品の画像（ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ：画像管理」で設定した画像）が表示されます。 定期に複数の商品が設定されている場合や商品に複数の画像が設定されている場合に表示される画像については、以下をご参照ください。 ▼定期に複数の商品が設定されている場合 画像が設定されている1つ目の商品（ecforce管理画面の【受注管理 > 定期受注管理 > 該当定期の詳細】画面の「タブ：受注商品管理」で1番上に表示されている商品）の画像が表示されます。 ▼商品に複数の画像が設定されている場合 ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ：画像管理」で1番上に表示されている画像が表示されます。
送信ボタンテキスト	ユーザーが複数の定期を契約している場合、ユーザーが定期を選択できます。 情報を送信するボタンのテキストを設定してください。

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

ecforce 定期商品詳細API

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

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

項目	説明
API URLスキーム	「https」と設定してください。
APIドメイン	ecforceのAPI接続用URLのドメインを設定してください。
SKU ID	特定の商品の詳細を取得したい場合のみ、商品のSKU IDを設定してください。 ※SKU IDは複数設定できます（上限なし）。複数のSKU IDを設定する場合は、改行区切りで設定してください。
定期商品選択メッセージ	定期に複数の商品が設定されている場合、メッセージを表示することができます。 表示させたいメッセージを設定してください。
項目名	定期に複数の商品が設定されている場合、「選択方式」で設定した方式で商品の一覧が表示されます。 項目名として表示したいテキストを設定してください。
選択方式	定期に複数の商品が設定されている場合、ユーザーが商品を選択できます。 商品の選択方式を設定してください。 ・セレクトボックス ・ラジオ（カルーセル） 表示される画像について ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ：画像管理」で設定した画像が表示されます。 商品に複数の画像が設定されている場合は、ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ：画像管理」で1番上に表示されている画像が表示されます。 ・ラジオ（テキスト） ・ラジオ（商品画像） 表示される画像について ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ：画像管理」で設定した画像が表示されます。 商品に複数の画像が設定されている場合は、ecforce管理画面の【商品管理 > 商品管理 > 該当商品の詳細】の「タブ：画像管理」で1番上に表示されている画像が表示されます。
送信ボタンテキスト	定期に複数の商品が設定されている場合、ユーザーが商品を選択できます。 情報を送信するボタンのテキストを設定してください。

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

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

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

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

項目	説明
API URLスキーム	「https」と設定してください。
APIドメイン	ecforceのAPI接続用URLのドメインを設定してください。
商品選択メッセージ	チャットで表示させるメッセージを設定してください。
項目名	プルダウンの項目名として表示したいテキストを設定してください。
選択方式	商品の選択方式を設定してください。 ・セレクトボックス ・ラジオ（カルーセル） ・ラジオ（テキスト） ・ラジオ（商品画像）
送信ボタンテキスト	情報を送信するボタンのテキストを設定してください。

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

ecforce 定期商品変更API

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

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

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

ecforce 定期配送スキップAPI

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

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

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

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

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

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

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

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

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

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

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

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

ecforce 定期停止API

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

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

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

ecforce 定期停止API（マイページ挙動）

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

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

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

ecforce 定期キャンセルAPI

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ecforce 顧客LINE ID更新API

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

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

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

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

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

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

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