この記事では、Agentファイルを使い始める際に必要な、マイページの初期設定についてご説明します。
このガイドで分かること
Salesforce側の設定
Agentファイルをご利用いただくにあたり、マイページ側でのOAuth設定が必要となります。
このOAuth設定を行うには、接続先となるSalesforce組織の情報を事前に設定いただく必要があるので、以下に設定手順をご案内します。
🔻手順
接続するSalesforceにログインして、マイページ用の外部クライアントアプリケーションを作成します。
①Salesforceの設定から「外部クライアントアプリケーションマネージャー」の「設定」を選択します。
外部クライアントアプリケーションへのオプトインを選択します。 ※ない場合設定不要です
②外部クライアントアプリケーション設定を行うユーザー様のプロファイルにて、一般ユーザー権限「外部クライアントアプリケーションの作成、編集、削除」にチェックをいれます。
③Salesforceの設定>「外部クライアントアプリケーションマネージャー」>「新規外部クライアントアプリケーション」を選択します。
④基本情報の必須項目に任意の値を入れます。配信状態はローカル固定です。
「取引先責任者メール」項目は、どのメールアドレスでも問題ございません。(マイページでは使用しないため)
⑤API(OAuth設定の有効化)で「OAuthを有効化」にチェックをいれてOAuthの設定を表示します。
⑥「コールバックURL」にはコールバックURLを入力します。形式は「マイページのURL + /admin/connect」です。
例:https://mypage.soasc.net/テナントID/admin/connect
「OAuth範囲」では「APIを使用してユーザーデータを管理(api)」と「いつでも要求を実行(refresh_token_offline_access)を選択します。
⑦「セキュリティ」には「Webサーバーフローの秘密が必要」と「更新トークンフローの秘密が必要」にチェックをいれます。
⑧「作成」ボタンをおして作成完了です。
⑨「コンシューマー鍵」と「コンシューマーの秘密」を取得します。
設定 > 外部クライアントアプリケーションマネージャーから、作成した外部クライアントアプリケーションを選択します。
⑩「設定」タブのOAuth 設定を開き、「コンシューマー鍵と秘密」をクリックします。
⑪実行者ユーザーのメールアドレスに認証メールが飛ぶので、認証するとコンシューマー鍵とコンシューマーの秘密を取得できます。
マイページ側の設定
Salesforceから取得した「コンシューマー鍵」と「コンシューマーの秘密」を使用して、OAuthの設定を行います。
加えて、「外部からの接続ユーザーの作成」と「Salesforceとの接続」を実施します。
🔻前提
管理者ユーザー(システム管理者権限が付与されているユーザー)で設定を行います。
管理者の中でも「システム管理者権限」が付与されている特別なユーザーにのみ「システム管理者設定」タブが表示されます。
🔻手順
①OAuthの設定を行います。
管理者でマイページにログインし、「システム管理者設定」>「システム設定」タブを開きます。
②OAuthの設定を埋めます。記述内容は以下表の通りです。「私のドメイン」箇所は補足に記載のものをいれます。
記載後、下部の「更新する」ボタンを押下します。
| 設定項目 | 記述内容 |
|---|---|
| OAuthのコンシューマ鍵 | 取得したコンシューマー鍵を記述する |
| OAuthのコンシューマ秘密 | 取得したコンシューマー秘密を記述する |
| OAuthのリダイレクトURL |
https://mypage.soasc.net/テナントID/admin/connect お客様側で設定する必要はございません。 |
| OAuthの認可エンドポイント | https://私のドメイン/services/oauth2/authorize |
| OAuthのトークンエンドポイント | https://私のドメイン/services/oauth2/token |
| OAuthのトークン破棄エンドポイント | https://私のドメイン/services/oauth2/revoke |
📝 補足:
・「私のドメイン」… Salesforce組織に設定されている My Domain を指します。例)https://example.my.salesforce.com
・「テナントID」… オプロからご案内している一意のテナントID
③次に外部からの接続ユーザーの作成 を行います。
管理者でマイページにログインして、「システム管理者設定」>「API接続ユーザー設定」にてユーザーを登録します。
・API接続ユーザーは、Salesforceに限らず外部からの通信専用のユーザーとします。
・API接続ユーザーに登録したメールアドレスでは、マイページへログインができません。
・API接続ユーザーは、システム管理者しか作成・編集できません。
API接続ユーザーを選択し、
登録します。
| 設定項目 | 記述内容 |
|---|---|
| ログインID |
こちらに登録したメールアドレスでは、マイページへログインすることができなくなるのでご注意ください。 実在しないメールアドレスを登録しても問題ありません。 |
| パスワード |
「システム管理者設定>システム設定>パスワード文字列の設定」で確認できるパスワードの設定が反映されるので、その設定に沿ってパスワードを入力してください。 |
④最後に、Salesforceとの接続を行います。※こちらは管理者ユーザーでしたらどなたでも設定可能です。
管理者でマイページにログインして、「接続トークン更新」ボタンからAgentファイルを使用するSalesforce組織と接続します。
マイページ側の設定は以上です。
🔻関連トピック
- 送信先ユーザーを事前にマイページに登録する場合、以下の手順よりご登録をお願いします。