Workivaの構築済みプレミアムコネクター以外のサードパーティアプリケーションへの接続をお探しですか?これは、HTTP Request Connector Commands を活用して REST API とやり取りすることで実現できます。
この Connected Learning Path では、ベアラートークンを取得するためにサードパーティ API で認証するチェーンを作成します。 Workiva API を使用してこのデモンストレーションを行いますが、原理とプロセスは他の様々な API との接続にも適用できます。
| プライマリビジネスユースケース | サードパーティシステムとの接続 |
| プライマリ学習目標 | 基本的なチェーンの概念を学び、WorkivaのHTTPリクエストコネクターコマンドを活用して、サードパーティのREST APIに接続し、認証することができます。 |
| 二次学習目標 | ワークスペース変数の作成 |
| 前提条件 | Workiva API グラントの構成 HTTP リクエストコネクターの構成 |
| サポートテンプレート | CLP | アクセストークンの生成 |
ステップ 1:ワークスペース変数の作成
複数のチェーンとコマンドで Workiva API の詳細を使用するために、その情報を格納するワークスペース変数を作成します。以下のデータ用に 3 つのワークスペース変数を作成します:API Grant Client ID と Client Secret、および IAM (ID およびアクセス管理) Base URL。
- チェーンビルダー から、ワークスペース設定 に移動します。
-
Workspace Variables で、プラス記号(+)を 3 回クリックして 3 つのワークスペース変数を作成し、以下を構成します:
- 変数 1: 変数 1:
- 名称: wsv-Workiva API クライアント ID
- 値: API Grant のClient ID を入力.
クライアント ID を検索するには、Workiva Platform 内の Profile に移動し、Security タブの下にある API Grant を検索します。
API Grants の詳細については、以下の手順に従ってください。
- 変数 2:
- 名称:wsv-Workiva API Client Secret
- 値 API Grant のClient ID を入力.
Client Secret を検索するには、Workiva Platform 内の Profile に移動し、Security タブの下にある API Grant を検索します。
クライアントシークレットの検索については、以下の手順に従ってください。 -
クライアントシークレットを暗号化するにはロックボタンをクリックします。
クライアントシークレットを安全に保管することは重要です。再度クライアントシークレット を使用する必要がある場合に備えて、クライアントシークレットを安全な場所に保存して ください。
-
変数 3:
- 名称: wsv-BaseURL-IAM
- 値: 地域に応じて、以下の値を入力してください。URL を確認することで地域を確認できます。URL に
EUまたはAPACが含まれている場合は、対応する URL を使用してください。
メモ: 米国地域には「app」のみが含まれます。
フィールド US値 IAM ベース URL https://api.app.wdesk.com フィールド EU値 IAM ベース URL https://api.eu.wdesk.com フィールド APAC値 IAM ベース URL https://api.apac.wdesk.com - ワークスペース設定を保存します。
- 変数 1: 変数 1:
ステップ2:チェーンの作成
ベアラ・トークンを生成するために、POST Command で新規チェーンを作成します。
- チェーンビルダー内のChains タブ にナビゲーションします。
- 新規チェーンを作成し、チェーンに名称を付けます:CLP | Generate Access Token.
- 説明を含みます:このチェーンは新規 Workiva API アクセストークンを生成します。 以下の変数値に、前へ生成した API Grant から有効なクライアント ID とクライアントシークレットを提供する必要があります。
- チェーンを保存します。
ステップ 3: トークンの取得
このチェーンは、ベアラートークンを取得するために HTTP Request Connector からPOSTコマンドを使用します。ベアラートークンは、APIに使用するために必要な重要な認証情報です。チェーン内で取得されたトークンは、後続のコマンド内で使用することができます。
- HTTP リクエスト コネクタから投稿コマンドを開始エリアに追加します。
- コマンドをダブルクリックして構成します。
- コマンドの名前を変更します:POST - トークンの取得.
- Show response チェックボックスをオンにします。
-
URL フィールドに、必要なエンドポイントの URL を入力します。Workiva API のトークンを取得するには、ワークスペース変数を使用して IAM ベース URL に以下の URL を入力します。
- URL をクリックし、"Select a variable "パネルでワークスペース をクリックし、ステップ1で作成した変数 (wsv-BaseURL-IAM) を選択します。
- 変数の後に/oauth2/token を追加します。
- Content Type フィールドに次のように入力します:application/x-www-form-urlencoded.
-
ヘッダーフィールドを追加するには、プラス 記号を使用します。
- キー:キー : 承認
- 値: application/json
-
ヘッダーフィールドを追加するには、プラス 記号を使用します。
- キーXバージョン
- 値: 2026-01-01
投稿フォーム に入力したパラメータを使って実行する方法をエンドポイントに伝えます。そのためには、Formセクションの次へ緑のプラスボタンを4回クリックし、大文字と小文字に注意しながら各フィールドに以下の値を入力してください。
- フィールド1
- 名称: client_id
- Value: <wsv-Workiva>
Select a Variable パネルで、下矢印をクリックしてWorkspace を展開し、wsv-Workiva API Client ID を選択します。
- フィールド 2:
- 名称: client_secret
- Value: <wsv-Workiva>
Select a Variable パネルで、下矢印をクリックしてWorkspace を展開し、wsv-Workiva API Client Secret を選択します。
- フィールド 3:
- 名称: grant_type
- 値: client_credentials
- フィールド 4:
- 名称: スコープ
- 値: オプションでここに値を追加し、このトークンが使用するスコープを指定します。
-
レスポンス に以下のサンプルペイロードを入力します。こうすることで、コマンド出力に書式を設定し、返される各変数を使いやすくします。
{ "access_token":"string", "expires_in":"integer", "scope":"string", "token_type":"文字列" }。
- (オプション)説明 を入力します:"この HTTP コマンドは、Workiva IAM API を使用する後続の HTTP コマンドで認証に必要なアクセストークンを生成するための投稿呼び出しを実行します。このコマンドは、ワークスペース変数を活用して、Workiva IAM API のベース URL、および API Grant Client ID と Client Secret を格納します。詳細はhttps://developers.workiva.com/2026-01-01/tokenrequest.html。
- コマンドを保存します。
ヒントフォームフィールドとレスポンスフィールドの入力方法については、接続先の API エンドポイントのデベロッパードキュメントを参照してください。Workiva API については、こちらでベアラートークンのドキュメントを検索できます 。
ステップ4:テストの手順
チェーンが完成したら、結果をテストする。
- チェーンを更新します。
- Execute をクリックしてから、Run Chain を実行します。
-
チェーンの実行が完了すると、Post Command のOutputs タブ - Response Body にアクセストークンが生成されていることが確認できるはずです。
次へ HTTP Request Connected Learning Path 内の演習をチェックして、その後のコマンドリストスプレッドシート内でベアラートークンを使用する方法を学んでください 。