API接続用のユーザー作成方法と認証トークン(アクセストークン)・APIログイン用パスワードの発行方法を教えてください。
[オプション]外部サービスAPI連携を利用したAPI接続にあたり、まずはAPI接続用のユーザー(メンバーアカウント)を作成することを推奨します。
作成したAPI接続用のユーザーから、API接続用の認証トークンやパスワードを発行します。
API接続用ユーザーを招待する
「設定 > メンバー/権限 > メンバー管理 」画面右上の「メンバー招待」ボタンよりAPI接続用のメンバーを招待します。詳細については「ecforce accounts の 新規メンバーの招待」をご確認ください。
| メールアドレス | 任意 ※受信可能なメールアドレスである必要があります。個人のメールアドレスは非推奨です。 |
| メンバー種別 | メンバー |
| ロール | 任意 ※あくまでecforce管理画面内を操作する上での権限です。 |
API接続用ユーザーでログインする
招待メールを受信できる方にサインアップおよびログインを依頼してください。
自身で対応する場合は、管理画面右上のユーザー名からログアウトし、招待メールからAPI接続用ユーザーでサインアップおよびログイン後に、再度自身のユーザーでログインし直してください。
ログインすることで、「設定 > メンバー/権限 > メンバー管理 」画面に招待したメンバーアカウントが表示されます。
API接続用の認証トークン・パスワードを発行する
「設定 > メンバー/権限 > メンバー管理 > 該当ユーザーの詳細」画面の「API 認証トークン」欄の「発行」ボタンを押下すると、「API 認証トークン」「パスワード」が表示されます。
「API 認証トークン」および「パスワード」は発行時のみ表示されます
「API 認証トークン」および「パスワード」は機密情報のため、発行時あるいは再発行時にのみ表示されます。画面を遷移したりリロードしたりすると、以降はマスク化された表示となり、発行済みの値を取得することはできなくなりますのでご注意ください。
なお、これらの情報が漏洩すると、APIエンドポイントを通じて該当ユーザーとしての操作が可能となりますので、取り扱いには充分に注意し、値を控える場合は第三者がアクセスできない安全な場所にショップ様の責任の下で保管してください。
万一情報が漏洩した場合は、ただちに再発行し、連携している外部サービスの設定を更新してください。再発行した場合、以前の「API 認証トークン」および「パスワード」は即時無効となります。
外部サービスとの接続がうまくいかない場合
接続に必要な情報や設定方法詳細はご利用の外部サービス次第となりますため、外部サービス側にご確認ください。
ここでは参考までによくある例をご紹介します。
| APIエンドポイント | 基本的にドメインとなりますが、正確な値は「外部サービスAPI連携」オプションの実装完了メールに記載がありますのでご確認ください。 |
| メールアドレス | ①で招待したメンバーアカウントのメールアドレスです。 |
| API認証トークン(アクセストークン) | ③で発行した「API認証トークン」です。 |
| パスワード | ③で発行した「パスワード」であるケースがほとんどです。②でサインアップした際に設定したログインパスワードとどちらを求められているかご確認ください。 |
この記事の目次
このセクションの記事