Postman 環境の設定

Postman を使用すると、Common Data Service インスタンスに接続して、Web API 要求を構成および送信し、応答を表示できます。 認証管理は多くの人たちにとって課題となります。 このトピックでは Postman 環境を Common Data Service 環境で機能するように構成する方法について説明します。

ユーザーが接続するために使用する一連の変数を保存するために Postman 環境を使用できます。 これらの値には、次の構文を使用することで postman 内でアクセスできます: {{name}}。 Postman 変数の詳細については Postman のドキュメント > 変数 を参照してください。

前提条件

Common Data Service 環境に接続

この環境では、すべての Common Data Service 環境で登録されるアプリケーションのクライアント ID を使用します。

これらの説明で提供されている clientid および callback の値を使用できます。 ただし、独自のアプリケーションを構築するときは、独自の Azure Active Directory (Azure AD) アプリケーションを登録する必要があります。

独自の Azure AD アプリケーションを登録するには、チュートリアル: Azure Active Directory への Common Data Service アプリの登録に記載される手順を参照してください。

Common Data Service インスタンスと接続するのに使用できる Postman 環境を作成するには、これらのステップを使用します:

  1. Postman デスクトップ アプリケーションを起動します。
  2. 右上隅の 環境オプション の歯車アイコンをクリックします。
  3. 新しい環境を追加するには 環境の管理 ダイアログ ボックスで 追加 ボタンを選択します。

追加ボタンをクリックして新しい Postman 環境を追加する

  1. 開くダイアログ ボックスに、環境の名前を入力します。 それから、編集領域へ次のキーと値のペアを追加します。

    変数名 Value
    url https://<add your environment name, like 'myorg.crm'>.dynamics.com
    clientid 51f81489-12ee-4a9e-aaae-a2591f45987d
    version 9.0
    webapiurl {{url}}/api/data/v{{version}}/
    callback https://callbackurl
    authurl https://login.microsoftonline.com/common/oauth2/authorize?resource={{url}}

    新しい Postman 環境を作成してオンライン インスタンスと接続する

  2. インスタンス URL のプレースホルダー値を Common Data Service インスタンスの URL と置換して、追加をクリックして環境を保存します。

  3. 環境の管理 ダイアログ ボックスを閉じます。

環境で使用するアクセス トークンの生成

OAuth 2.0を使用して接続するには、アクセス トークンが必要です。 新しいアクセス トークンを取得するには、次のステップを実行します:

  1. 作成した新しい環境が選択されていることを確認します。

  2. 認証タブを選択します。

  3. 種類OAuth 2.0に設定します。

  4. 作成した環境を選択していることを確認します。

  5. 新しいアクセス トークンの取得 を選択

    認証タブで、種類を OAuth 2.0 に設定する

  6. ダイアログ ボックスに以下の値を設定します。 種類の許可 ドロップダウン メニューから Implicit を選択します。 トークン名 を任意のものに設定して、そのほかのキーは既定値のままに設定できます。

    新しいアクセス トークンの取得

    注意

    異なるユーザーの資格情報を使用して複数の Common Data Service インスタンス用に Postman の環境を構成している場合、Postman によってキャッシュされた Cookie を削除することが必要な場合があります。 送信 ボタンの下にある Cookie リンクを選択して、Cookie の管理 ダイアログ ボックスから保存されたクッキーを削除します。
    Cookie の削除
    これらの Cookie の一部は非常に永続的です。 グループでそれらの一部を削除できるものもあれば、他は個別に削除する必要がある場合もあります。 Cookie が残っていないことを確認するには、これを 2 回する必要がある場合があります。

  7. トークンの要求 を選択します。 これを行うと、Azure Active Directory のログイン ページが表示されます。 ユーザー名とパスワードを入力します。

  8. トークンが生成されたら、一番下にスクロールして トークンの使用 を選択します。 これにより アクセス トークンの管理 ダイアログ ボックスが閉じます。

  9. トークンを追加すると、必要に適用するトークンを選択できます。 使用できるトークン ドロップダウン リストで、作成したばかりのトークンを選択します。 認証ヘッダーが API Web 要求に追加されます。

接続を確認するステップについては、接続のテスト を参照してください。

接続のテスト

Common Data Service インスタンスと接続するテストのための新しい Web API 要求を作成します。 WhoAmI functionを使用するには、次の操作を実行します。

  1. HTTP メソッドとして GET を選択し、編集スペースで {{webapiurl}}WhoAmI を追加します。 WhoAmI 関数要求
  2. この要求を送信するには 送信 を選択します。
  3. 要求が成功した場合は WhoAmI Function によって返される WhoAmIResponse ComplexType からのデータを確認します。

関連項目

Postman を使用して操作を実行する
チュートリアル: Common Data Service アプリを Azure Active Directory に登録する