Postman を設定して接続する
Postman にサインアップして、ワークスペースを作成する
Postman のアプリケーションを操作する方法には、デスクトップと Web の 2 つのオプションがあります。このプロジェクトでは、Web ブラウザーアプリケーションを使用します。
- Postman アカウントにサインインするか、アカウントにサインアップします。
-
[Workspaces (ワークスペース)] メニューを選択します。
-
[Create Workspace (ワークスペースを作成)] を選択します。
- ワークスペースに
SalesforceCollection
という名前を付けます。
- [Visibility (表示)] を [Personal (個人)] に設定します。
-
[Create Workspace (ワークスペースを作成)] をクリックします。
Salesforce コレクションをフォークする
-
Salesforce 開発者の公開ワークスペースを開いて、Salesforce API コレクションのフォークを作成します。
- [Collections (コレクション)] で [Salesforce Platform APIs] を選択して展開します。
-
をクリックすると、コレクションのフォークが作成されます。
-
MySalesforceAPIFork
と入力します。
- [Workspace (ワークスペース)] は SalesforceCollection のままにします。
-
[Fork Collection (フォークコレクション)] をクリックします。
これで Postman のコレクションの準備ができました。このコレクションを使って組織を承認し、テストします。
組織を承認する
API にアクセスするには、Salesforce を使った認証が必要です。認証によって、一定期間有効なアクセストークンが得られます。アクセストークンの期限が切れるたびに、このプロセスを実施します。
- ブラウザーでログイン中の Trailhead Playground が 1 つのみであることを確認します。
- Postman の [Collections (コレクション)] で [Salesforce Platform APIs] を選択する必要があります。
-
[No Environment (環境なし)] が選択されていることを確認します。
- [Authorization (承認)] タブが開いていることを確認します。
- [Type (種別)] は [OAuth 2.0] にする必要があります。
-
[Get New Access Token (新しいアクセストークンを取得)] をクリックします。
-
[Allow (許可)] をクリックして、[Salesforce Platform APIs Collection for Postman (Postman 用 Salesforce Platform API コレクション)] が Trailhead Playground にアクセスできるようにします。
- 一時的に成功メッセージが表示された後、[Manage Access Tokens (アクセストークンを管理)] ダイアログにリダイレクトされます。
- [instance_url] で Trailhead Playground が指定されていることを確認します。
- ステップ 12 で使用するため、[instance_url] をコピーします。このとき URL のみをコピーし、余分な文字が入らないようにします。
-
[Use Token (トークンを使用)] をクリックします。
-
[Variables (変数)] タブを開きます。
- [_endpoint] 行の [CURRENT VALUE (現在の値)] 列に、ステップ 9 でコピーした instance_url を貼り付けます。
-
[Save (保存)] をクリックします。
クイック接続テスト
接続が機能していることを検証します。
- [Collections (コレクション)] で [Salesforce Platform APIs] を選択して展開します。
-
[REST] を選択して展開します。
-
[GET Limits] を選択します。
メインパネルで [Limits (制限)] が開きます。
-
[Send (送信)] をクリックします。
- 状況が [200 OK] であることを確認します。
場合によっては、異なるホスト名へのリダイレクトが生じた際に認証ヘッダーを保持するため、[Follow Authorization header (認証ヘッダーに従う)] 設定をオンにする必要があります。
これで、Salesforce を使った認証が正常に完了したので、コレクション内の他の要求を使用できるようになります。
取引先を転記する
組織からのデータの取得が完了したので、組織に新しいデータを追加してみましょう。
- [REST] の下の [SObject] を選択し、[POST SObject Create] を選択します。
-
[Params (パラメーター)] タブを開きます。
- [Path Variables (パス変数)] の下の [SOBJECT_API_NAME] 行の [VALUE (値)] 列に
Account
(取引先) と入力します。
-
[Body (ボディ)] タブを開きます。
- ボディのテキストを次のコードに置き換えます。
{ "Name": "Postman", "BillingState": "CA" }
-
[Save (保存)] をクリックします。
-
[Send (送信)] をクリックします。
Postman が新しいアカウントの ID を返します。
- 状況が [201 Created (201 作成済み)] であることを確認します。
- 承認済みの Playground を開きます。
- アプリケーションランチャー () で、[Accounts (取引先)] を見つけて開きます。
- 新しい取引先が表示されていることを確認します。
お疲れさまでした。組織とやり取りするための Postman の設定は完了です。ここで読み込んだ Postman 用 Salesforce API コレクションは、Salesforce API の検索要求で活用できます。
リソース
- GitHub: Salesforce APIs for Postman (Postman 用の Salesforce API)
- GitHub: Installing with the Postman Web UI (Postman Web UI を使ったインストール)
- YouTube: Use the Salesforce APIs Collection with the Postman Web UI (Postman Web UI を使った Salesforce API コレクションの活用) | Developer Quick Takes
- Salesforce ヘルプ: どの API を使用するか?
- Trailhead: Postman API Client (Postman API クライアント)