OAuth 2.0 ベースの API のモニタリング

最初の トークン取得タスク の主な目的は、アプリケーションがサービス API にアクセスするためのアクセストークンを取得することです。 成功した場合、アクセス トークンはサービス API 応答から取得し、後続の API 要求で使用できます。 さらに、タスクは、アクセス トークンのアプリケーション認証コードを交換するを確認します。 エラーが発生した場合、デバイスに対してアラートが生成されます。

デバイスを作成するには、[デバイス マネージャ] ページの[新しいデバイス] をクリックし、[HTTP/S タスク] を選択します。

URL

タスクを設定するには、認証サーバーへのアクセストークンリクエストを生成する必要があります。 [URL ] フィールドに、API 認証サーバーの URL を次の形式で指定します https://authorization-server.com/oauth/authorize。正確なURLは、接続しているサービスによって異なります。

SSL/証明書チェック

SSL 証明書チェックを有効にします。要求の種類と投稿データ クライアント認証パラメーター (クライアント ID とクライアント シークレット)、リダイレクト URI、および承認コードは、承認サーバーへの要求で指定する必要があります。POSTメソッド(Request Typeフィールド)を使用して、アプリケーションの詳細とコードを送信しましょう。

[Post Data] フィールドには、次のリクエスト本文属性を指定する必要があります。

• 
  client_id
  – 承認サーバーでアプリケーションが最初に登録したときに発行されるアプリケーション識別子。
• 
  client_secret
  – 承認サーバーでアプリケーションが最初に登録された時に発行されます。
• code – 認証サーバーから受信した認証コード。
• grant_type – 「authorization_code」に設定する必要があります。
• redirect_uri – URL は、以前にアプリケーションに登録したリダイレクト URL と一致する必要があります。

タスクの実行結果、レスポンス本文に認証サーバーからのアクセストークンを含むJSONレスポンスを受け取ります。

コンテンツの検証

サーバー応答がアクセス トークンと更新トークン (アクセス トークンの有効期限が切れた場合に使用される) を返すことを確認するには、次のキーワードを指定します。

• access_token
• refresh_token

必要に応じて、他のタスク フィールドを設定するには 、「HTTP(S) タスクの追加/編集」を参照してください。

セットアップが完了したら、[デバイスの 作成 ] をクリックし、次の手順に進み、アクセス トークンを使用して API 呼び出しを実装します。

トークン取得タスクの実行の結果としてアクセストークンを伴うAPI応答を受信した場合、サービスAPIを呼び出すためのトークンを抽出する必要があります。 たとえば 、/users エンドポイントを要求して、監視対象サービスのユーザーリストを取得します。

まず、トークン取得 タスク 応答本体から変数にトークンを抽出するスクリプトを作成します。 たとえば、次のスクリプトは、トークンとトークンの種類を 基本承認応答 から
TokenAuthorization
変数に渡します。

string access_token;
string token_type;
string TokenAuthorization;

// get the authorization response from the first task
string json = (Tasks["Get Token"] as Http).body["//*"];

//convert response to the comma separated strings
string[] comas = json.Split(new Char[] { ',' });

// get the access token
int start1 = comas[0].IndexOf(":") + 2;
int length1 = comas[0].Length - start1 - 1;
access_token = comas[0].Substring(start1, length1); 

// get the token type
int start2 = comas[1].IndexOf(":") + 2;
int length2 = comas[1].Length - start2 - 1;
token_type = comas[1].Substring(start2, length2);

// set the TokenAuthorization variable to specify in the data request header 
TokenAuthorization = token_type + " " + access_token;

最初のステップで構成された API 監視デバイスに新しいタスクを追加するには、次の手順を実行します。

1. [ デバイス マネージャ] ページで、デバイス行のアクション ボタン をクリックします。
2. [アクション] メニューの [ タスクの追加] をクリックします。

URL

[URL]フィールドで、データの抽出元となるサービス リソースの要求 URI を指定します。

SSL/証明書チェック

SSL 証明書チェックを有効にします。

要求の種類

GET要求の種類を選択します。

OAuth 2.0 では、HTTP GET 要求のAuthorizationヘッダーにアクセス トークンとトークンの種類を渡す必要がありますが、GET クエリ文字列または POST 本体パラメーターとして指定することもできます。

ヘッダー

承認

ヘッダー名とトークン承認

値を持つヘッダーを追加します。 TokenAuthorization

変数を動的変数に変換するには、値フィールドの歯車アイコンをクリックし、[値の編集] ダイアログで [動的] を選択します。

動的値フィールドは、角かっこで囲みます。

スクリプトの準備

アクセス トークンで渡すスクリプトを追加します。

コンテンツの検証

サービス応答で返されるデータを確認するために、対応するキーワードを指定することもできます。 たとえば、サービスから取得する予定のユーザー名が複数あるとします。

他のタスク フィールドを設定するには 、「HTTP(S) タスクの追加/編集」を参照してください。