REST APIとPostmanで始める

はじめに

Postmanダウンロード
REST APIを使用したアプリケーションのテストと構築にお勧めのプラットフォーム

DocuWare's REST API Postmanコレクション
DocuWare関連APIコールの事前設定済みコレクションで、Postmanにインポートすることができます。

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

1. ダウンロードしたPostman Collectionフォルダを解凍します。中に2つの.jsonファイルがあるはずです。
   • 1つは実際のAPIコールのコレクション用のファイルで、もう1つはDocuWare CloudのURL、ユーザー名、パスワードなどの必要な変数を保持する環境です。
2. Postmanを開き、ワークスペース・エディタの上部にあるインポート・オプションを使用します。
   
   
3. 2つのファイルをドラッグ＆ドロップするか、手動でダウンロード場所を参照して両方をインポートします。
4. 両方のファイルをインポートするプロンプトを受け入れます。

環境変数の定義

1. 左側のEnvironmentsタブを開き、新しくインポートしたDocuWare環境を選択します。
2. ここで、たくさんの変数があることに気づくでしょうが、ほとんどは使用ケースに特化したもので、今はそのままにしておいてかまいません。重要なものは以下の通りです：
   • ServerUrl（.cloud/.comなどで終わる。- DocuWare/Platformは別の変数に入れます)
   • ユーザー名
   • パスワード
3. 変更を保存します。

認証の取得

1. Postman CollectionのAuthentication/OAuthフォルダを開きます。
2. 1.Get Responsible Identity Service 呼び出しから開始し、Sendを押します。ServerUrl 変数が正しく設定されている場合、200 レスポンスが返されます：
   
3. 次に、 2.Get Identity Service Configuration
4. 最後に、使用する認証方法を選択する。この例では、3.a Request Token w/ Username & Password を使用する。
5. これで正しく認証され、Postman Collection内の他の様々な呼び出しのテストを始めることができる！

ほとんどのREST APIドキュメントは、Postmanの右側にあるDocumentationタブで直接見ることができます：

KBAはクラウドとオンプレミスの両方の 組織に 適用できます。

ご注意：この記事は英語からの翻訳です。この記事に含まれる情報は、オリジナルの英語版製品に基づくものです。翻訳版の記事で使用されている文法などには、細かい誤りがある場合があります。翻訳の正確さを完全に保証することは出来かねますが、ほとんどの場合、十分な情報が得られると思われます。万が一、疑問が生じた場合は、英語版の記事に切り替えてご覧ください。