Workiva API コレクションを Postman にインポート済み

このガイドでは、OpenAPI仕様を使ってWorkiva APIコレクションをPostman にインポートし、環境変数を設定し、リクエストをエンドツーエンドで検証する手順を説明します。

前提条件

作業を始める前に、以下のものが揃っていることを確認してください：

Workiva APIはOpenAPI (.yaml) フォーマットで公開されています。これらの仕様はPostmanに直接インポートすることができ、手作業でリクエストを作成することなく、より迅速な開発、テスト、統合ワークフローを実現します。

Postman でEnvironments タブを開き、新しい環境を作成する。テスト目的で、このガイドでは<WorkspaceName>_Workiva_APIという環境を使用します。

推奨OrganizationName_WorkspaceName などの一貫した命名規則を使用して、異なる Workiva ワークスペース間で変数を明確に区別する。

Current Value 列を使用して以下の変数を追加し、Save をクリックする。

オリジナル：
https://api.app.wdesk.com/iam/v1

更新:
https://api.{{environment}}.wdesk.com/iam/v1.

Retrieve a tokenから 、Scripts タブを選択し、Post-request セクションに以下のコードを追加します。

pm.test("Status code is 200",function () { pm.response.to.have.status(200); }); pm.test("アクセストークンを環境変数に保存",function () {var jsonData = pm.response.json(); pm.environment.set("access_token", jsonData；）
リクエストを送信します。200 OK レスポンスを受信し、access_token が自動的に保存されます。

コレクション内の各リクエストが親から継承された認証{{access_token}} を使用していることを確認する。

Wdata Code Generation 。
.yaml ファイルをダウンロードし、Postman にインポートします ( Step 1: Import the Workiva API Collection で説明されている手順に従ってください )。注： .yaml ファイル名は、おそらくWorkiva API Collection と同じになる。
Wdataコレクション：
- Authorization Type をBearer Token に設定します。
- トークン値として{{access_token}} を使用します。
- 変数タブで、baseUrl 変数を更新して、ハードコードされたドメインの代わりに{{environment}} を使用するようにします。これにより、app,eu,apac のような環境間の切り替えが容易になります。
- 各リクエストがInherit auth from parent に設定されていることを確認してください。
- 認証設定とbaseUrl 変数が同じように構成されていることを確認します。

正しい環境を参照していることを確認します。コレクションがデフォルトで No 環境に設定されている場合は、ご指定の環境 に切り替えてください。
baseUrl 変数が環境とコレクション設定で一貫していることを確認してください。
を使用するようにbaseUrl{{environment}} コレクション変数を設定してください。
リクエストが401または空白のレスポンスを返した場合は、クライアントID、クライアント・シークレット、API_version、およびEnvironmentの値が正しいことを再確認してください。