Workivaの内蔵プレミアムコネクター以外のサードパーティアプリケーションへの接続をお探しですか?これは、HTTP Request Connector コマンドを活用して REST API とやり取りすることで実現できます。この接続学習パスでは、ワークスペース内のスプレッドシートの一覧を取得するために list Spreadsheets エンドポイントを使用するコマンドで Bearer Token を使用するようにチェーンを更新します。
注:ここでは「HTTPリクエスト」と表記されていますが、HTTPS(セキュアHTTP)もサポートされています(推奨されます)。
| プライマリビジネスユースケース | サードパーティシステムとの接続 |
| プライマリ学習目標 | HTTP Request Connector を使用したチェーンの基本概念の学習 |
| 前提条件 | Workiva API グラントの 設定HTTP リクエスト・コネクタの設定 CLP - HTTP リクエスト トークンの生成 |
| サポートテンプレート | CLP - HTTP リクエストリストスプレッドシート |
ステップ 1:ワークスペース変数の作成
複数のチェーンとコマンドで Workiva API の詳細を使用するために、その情報を格納するワークスペース変数を作成します。Platform API URL の新規ワークスペース変数を作成します。
- 「Chain Builder」から、「ワークスペース設定」に移動します。
- 「ワークスペース変数」の下にあるプラス記号をクリックして、新しいワークスペース変数を作成します。
-
以下の情報を使用して変数を構成します:
- 名前:wsv-BaseURL-Platform
- 値:お住まいの地域に応じて、適切な値を使用してください。URLを確認することで地域を特定できます。URLに「
EU」または「APAC」が含まれている場合は、それぞれに対応するURLを使用してください。それ以外の場合はUS値を使用してください。
注:米国地域には「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 フィールド CA値 IAM ベース URL https://api.ca.wdesk.com - ワークスペースの設定を保存します。
注:これらの変数はすべて、ワークスペース設定に表示されているはずです。 そうでない場合は、上記の「前提条件」を再度確認してください。
ステップ 2: チェーンのコピーと修正
- 「Chain Builder」に移動し、「CLP | Generate a Token」という名前のチェーンを探してください。
- 右側にある縦の省略記号をクリックし、「コピー」を選択してください。
- チェーンのコピーが作成されたら、鉛筆のアイコンをクリックしてチェーンを編集します。
- 右上の「チェーン設定」をクリックしてください。
- チェーンの名前を変更:CLP | HTTPリクエスト一覧スプレッドシート。
- (任意)説明を入力してください:「このチェーンは、新しい Workiva API アクセストークンを生成します。以下の変数値に、以前に生成された API Grant から有効な Client ID と Client Secret を提供する必要があります。次に、ワークスペース内のすべてのスプレッドシートのリストを取得します。ワークスペースには、少なくとも 1 つ以上のスプレッドシートが必要です。" を参照してください。
- チェーンを保存します。
ステップ 3: スプレッドシートのリスト
当社のスプレッドシートのリストを取得するために、このチェーンでは GETコマンド HTTPリクエストコネクタから。
- HTTPリクエストコネクタから「Getコマンド 」をチェーンキャンバスに追加します。
- 「Post - トークンの取得」コマンドを「Get」コマンドに接続します。
- コマンドをダブルクリックして構成します。
- コマンドの名前を変更:Get - スプレッドシートの一覧
- コマンドを編集するには、コマンドをクリックし、関連する鉛筆アイコンをクリックします。
- [応答を表示] チェックボックスにチェックを入れます。
- 「URL」をクリックし、次に「変数の選択」パネルで「Workspace」をクリックして、手順 1 で作成した変数(wsv-BaseURL-Platform)を選択します。
- 変数の後に「/spreadsheets」を追加してください。 次に、GET形式 でヘッダーを 指定することで、エンドポイントに実行方法を指示します。
- 「ヘッダー」セクションの 横にある灰色のプラス(+)ボタンを2回クリックし、各フィールドに以下の値を入力してください。大文字と小文字の区別、および「Bearer」の後のスペースには特に注意してください。
- ヘッダーフィールド 1:
-
プラス記号を使って、ヘッダーフィールド を追加してください。
- キー:承認
- 値: application/json
- ヘッダーフィールド 2:
-
プラス記号をクリックして、ヘッダーフィールドを もう1つ追加してください。
- キー:X-バージョン
- 値:2026-01-01
-
投稿フォームに入力されたパラメータを用いて、エンドポイントに実行方法を指示します。そのためには、Formセクションの次へ緑のプラスボタンを4回クリックし、大文字と小文字に注意しながら各フィールドに以下の値を入力してください。
-
- フィールド1
- 名前:client_id
- 値: <wsv-Workiva API Client ID>
[変数の選択] パネルで、下向きの矢印をクリックして [Workspace] を展開し、[wsv-Workiva API Client ID] を選択します。
- フィールド 2:
- 名前:client_secret
- 値: <wsv-Workiva API Client Secret>
[変数の選択] パネルで、下向きの矢印をクリックして [Workspace] を展開し、[wsv-Workiva API Client Secret] を選択します。
- フィールド 3:
- 名前:grant_type
- 値:client_credentials
- フィールド 4:
- 名前:scope
- 値:必要に応じて、このトークンがアクセスできるスコープを指定するために、ここに値を追加してください。
- フィールド1
- レスポンスに以下のサンプルペイロードを入力します。こうすることで、コマンドの出力に書式を設定し、返却される各変数を使いやすくしています。
{ "access_token":"string", "expires_in":"integer", "scope":"string", "token_type":"文字列" }。-
(任意)説明を入力してください:「このコマンドは、スプレッドシートのリストを1ページ分返します。詳細については、https://developers.workiva.com/2026-01-01/getspreadsheets.htmlの開発者向けドキュメントをご覧ください。
ヒントヘッダーおよびレスポンスの各フィールドにどのような値を設定すべきかを確認するには、接続先のAPIエンドポイントに関する開発者向けドキュメントを参照してください。この例では、「Get Spreadsheets」エンドポイントを使用しています。
- コマンドを保存する。
ステップ 4:テストの手順
チェーンが完成したら、結果をテストする。
- チェーンを公開する。
- [実行] をクリックし、続いて [チェーンを実行] をクリックします。
- チェーンの実行が完了すると、「出力」タブにスプレッドシートのリストが表示されます。これは、GETコマンドのレスポンス本文です。
引き続き自分自身に挑戦し、HTTPリクエストコネクタを使用してサードパーティのAPIに接続する方法についてさらに学びたい場合は、次の演習「CLP - HTTPリクエストで単一のスプレッドシートを取得する」をご覧ください。