Microsoft #Graph 開発に #Postman を使用する手順~ #1 初期設定編

Office 365 のリソースにアクセスするために利用する RESTful な Web API が、Microsoft Graph。(みんな知ってますね)

クライアントの開発時に、基本的に必要なものが以下の2つ。

でも、もう少し効率よく API を叩いてみたいことがよくあります。

そこで Postman の出番。

ちょっと Graph API を調べる用事(仕事 /笑)がありまして。
以前「Postman で Graph API 呼びやすくなったよ」という話を聞いた覚えがあり、 じゃあということで設定して実際に Postman で叩いてみました。

難しい手順ではないのですが、ちょっとだけ面倒だったり、設定マニュアル が分かりづらかったりしたので、改めて手順をまとめてみました。

長くなるので 2回に分けます。今回は Postman の初期設定編。

設定の手順をステップバイステップで紹介します。
今回の手順は、一度やっておけば次からはすぐに使えて幸せになれます。


専用のワークスペースを作る(必須ではありません)

ワークスペースの [Create New] を選択します。

名前を入力し、[Type] は適切なもの(私は “Personal” を選択)を選択して [Create Workspace] をクリックします。

Environment のインポート

Environment は Web サービス接続のための環境です。
Environment ごとに個別の環境変数のコレクションを持つことができます。

[File]-[Import] を選択し、ポップアップが表示されたら、[Import From Link] を選択して以下の URL を入力します。

https://raw.githubusercontent.com/microsoftgraph/microsoftgraph-postman-collections/master/Microsoft%20Graph%20v1.0.postman_environment.json

Microsoft Graph environment” という Environment が出来ています。

環境変数は、Environment の右にある [Environment quick look] ボタン(「目」のイメージ)をクリックすると見られます。


コレクションのインポート

同様の操作で、Graph API のコレクションをインポートします。

[File]-[Import] を選択し、ポップアップが表示されたら、[Import From Link] を選択して以下の URL を入力します。

https://raw.githubusercontent.com/microsoftgraph/microsoftgraph-postman-collections/master/Microsoft%20Graph%20v1.0.postman_collection.json

Microsoft Graph のコレクションが追加されます。

これで、呼び出したい機能を選択すると、エンドポイントが自動的に URL 欄にコピーされます。
※今の時点では、環境変数の保存ができていないので呼び出しに失敗します。


AAD 管理センターで環境変数をコピー

Azure Active Directory 管理センター で以下の値をコピーします。

  • Tenant ID
  • Client ID
  • Client Secret (Postman 用に新規にシークレットを作成します。後述)

Azure Active Directory 管理センター に接続して、[Azure Active Directory]-[アプリの登録] を開きます。

開発対象のアプリケーションを選択します。
または [新規登録] で新しいアプリケーションを登録します。
アプリ新規登録の手順は本稿のテーマではないため、必要に応じて この記事 などを参考にしてください。

アプリの 概要 ブレードで、Client ID および Tenant ID の値をコピーします。

[証明書とシークレット] を選択し、[新しいクライアントシークレット] をクリックします。
適切な説明(名前)と有効期間を指定して、Postman 用のクライアントシークレットを追加します。

作成された値はコピーしておきます。


Postman の環境変数に貼り付け

AAD 管理センターでコピーした3個の値を Postman の環境変数として保存します。

Postman に戻り、Environment の右にある [Manage Environments] ボタン(歯車)をクリックします。

Microsoft Graph environment” を選択します。

AAD 管理センターでコピーした3つの値を Environment の 対応する行の “CURRENT VALUE” フィールドに貼り付けます。
[Update] ボタンをクリックして値を保存してから、[MANAGER ENVIRONMENTS] 画面を閉じます。


初期設定の確認

ここまでで初期設定は終わりです。
正しく設定できたことを確認します。

[Microsoft Graph] コレクションで、[Application] の中にある [Get App-Only Token] をクリックします。
新しいタブが開いて、Token 取得の EndPoint があらかじめ入力されています。

[Send] ボタンをクリックすると、レスポンスが表示されます。
access_token” が取得できていれば、初期設定は成功です。


以上で Postman で Graph 開発をする初期設定は完了です。

次回 は、開発時の操作方法や Tips を紹介します。

Microsoft #Graph 開発に #Postman を使用する手順~ #1 初期設定編」への1件のフィードバック

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト /  変更 )

Google フォト

Google アカウントを使ってコメントしています。 ログアウト /  変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト /  変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト /  変更 )

%s と連携中