この記事では、Agentファイルを使い始める際に必要な初期設定についてご説明します。

6つのステップで「Agentファイル」を利用開始するまでの準備が完了します。

🔰設定の流れ

💡 はじめて設定される方へ

設定を始める前に、下の動画で全体の流れをご確認いただくとスムーズです。

▶ [動画を見る]

✅目次

1. Salesforce上の設定
 STEP1. 外部クライアントアプリケーションの作成
 ①. 外部クライアントアプリケーションマネージャーの設定
 ②. 対象ユーザの権限付与
 ③. 外部クライアントアプリケーションの作成
 ④. 基本情報の入力
 STEP2. OAuth・セキュリティを設定
 ⑤. OAuth設定の有効化（API設定）
⑥. コールバックURL・OAuth範囲の設定
 ⑦. セキュリティ設定
 STEP3. 鍵・秘密を取得
 ⑧. 作成済み外部クライアントアプリケーションの選択
 ⑨. OAuth設定（コンシューマー鍵・秘密）の表示
 ⑩. コンシューマー鍵／秘密の取得

2. マイページ上の設定
 STEP4. OAuth設定
 ①. マイページ管理者設定画面の表示
 ②. OAuth設定の実施（Salesforceから取得した鍵・秘密を使用）
STEP5. API接続ユーザーを作成
 ③. 外部接続用（API）ユーザーの作成
 STEP6. Salesforceとの接続
 ④. 「接続トークン更新」からSalesforceとの接続

１.Salesforce上の設定

Agentファイルをご利用いただくにあたり、マイページ側でのOAuth設定が必要となります。

このOAuth設定を行うには、接続先となるSalesforce組織の情報を事前に設定いただく必要があるので、以下に設定手順をご案内します。

🔻手順

STEP1. 外部クライアントアプリケーションの作成

接続するSalesforceにログインして、マイページ用の外部クライアントアプリケーションを作成します。

①Salesforceの設定から「外部クライアントアプリケーションマネージャー」の「設定」を選択します。

外部クライアントアプリケーションへのオプトインを選択します。 ※ない場合設定不要です

②外部クライアントアプリケーション設定を行うユーザー様のプロファイルにて、一般ユーザー権限「外部クライアントアプリケーションの作成、編集、削除」にチェックをいれます。

③Salesforceの設定＞「外部クライアントアプリケーションマネージャー」＞「新規外部クライアントアプリケーション」を選択します。

④基本情報の必須項目に任意の値を入れます。配信状態はローカル固定です。

「取引先責任者メール」項目は、どのメールアドレスでも問題ございません。（マイページでは使用しないため）

STEP2. OAuth・セキュリティを設定

⑤API(OAuth設定の有効化)で「OAuthを有効化」にチェックをいれてOAuthの設定を表示します。

⑥「コールバックURL」には以下を入力します。

検証環境	検証環境のマイページURL + /admin/connect 例：https://mypage-stg.soasc.net/テナントID/admin/connect
本番環境	本番環境のマイページURL + /admin/connect 例：https://mypage.soasc.net/テナントID/admin/connect

「OAuth範囲」では「APIを使用してユーザーデータを管理(api)」と「いつでも要求を実行(refresh_token_offline_access)を選択します。

⑦「セキュリティ」には「Webサーバーフローの秘密が必要」と「更新トークンフローの秘密が必要」と「更新トークンのローテーションを有効化」にチェックをいれます。

⚠️「サポートされる認証フローに Proof Key for Code Exchange (PKCE) 拡張を要求」のチェックは外れた状態にしてください

「セキュリティ」まで設定したら、「作成」ボタンをおして作成完了です。

STEP3. 鍵・秘密を取得

「コンシューマー鍵」と「コンシューマーの秘密」を取得します。

⑧設定 > 外部クライアントアプリケーションマネージャーから、作成した外部クライアントアプリケーションを選択します。

⑨「設定」タブのOAuth 設定を開き、「コンシューマー鍵と秘密」をクリックします。

⑩実行者ユーザーのメールアドレスに認証メールが飛ぶので、認証するとコンシューマー鍵とコンシューマーの秘密を取得できます。

※外部クライアントアプリケーションの「アプリケーションの状況」は「有効」にしてください。

▲ 目次へ戻る

２.マイページ上の設定

使用するマイページテナントにログインします。

Salesforceから取得した「コンシューマー鍵」と「コンシューマーの秘密」を使用して、OAuthの設定を行います。

加えて、「外部からの接続ユーザーの作成」と「Salesforceとの接続」を実施します。

🔻前提

管理者ユーザー（システム管理者権限と管理者権限が付与されているユーザー）で設定を行います。

🔻手順

STEP4. 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

📝 補足：

・接続する環境（Sandbox・本番）にあわせて「コンシューマ鍵」「コンシューマ秘密」「私のドメイン」情報を指定します。

・「私のドメイン」… Salesforce組織に設定されている「現在の[私のドメイン]のURL」を指します。
画像.png

STEP5. API接続ユーザーを作成

③次に外部からの接続ユーザーの作成を行います。

管理者でマイページにログインして、「システム管理者設定」＞「API接続ユーザー設定」にてユーザーを登録します。

⚠️注意点

API接続ユーザーは、Salesforceに限らず外部からの通信専用のユーザーとします。
API接続ユーザーに登録したメールアドレスでは、マイページへログインができません。
API接続ユーザーは、システム管理者しか作成・編集できません。

API接続ユーザーを選択し、

登録します。

STEP6. Salesforceとの接続

④最後に、Salesforceとの接続を行います。

管理者でマイページにログインして、「接続トークン更新」ボタンからAgentファイルを使用するSalesforce組織と接続します。

⚠️接続したSalesforce環境を入れ替える場合は、入れ替える前にシステム管理者設定で「Salesforceとの接続を切断」する必要があります。

マイページ側の設定は以上です。