アプリケーションの作成の次のステップ
ここでは「Postman」を利用してAPIリクエストを行う際の手順を紹介します。
Postmanとは
- 「Postman」は一から開発環境を構築せずに、簡単にHTTPリクエストを作成・テストできる開発者向けのツールです。
- freeeは “Collection” と呼ばれる形でAPIをPostmanで公開しており、これを利用することで簡単にfreee会計・freee人事労務のAPIを利用することができます。
- PostmanのCollectionについて
PostmanでCollectionをforkする
- postman.com のアカウントにサインアップまたはログインします。
- freee Public API Workspace にアクセスし、Collectionをforkします。
認証設定を行う
- 「アプリケーションを作成する」で作成したOauthアプリケーションにコールバックURLを設定します。
- デスクトップアプリをご利用の方は「https://oauth.pstmn.io/v1/callback」を設定します。
- ブラウザ上でご利用の方は「https://oauth.pstmn.io/v1/browser-callback」を設定します。
- デスクトップアプリをご利用の方は「https://oauth.pstmn.io/v1/callback」を設定します。
- OauthアプリケーションのClient ID/SecretをCollection変数に設定します。
- アクセストークンを取得します。
- PostmanのOAuth 2.0 認証について
- Authorizationタブの一番下にある「Get New Access Token」をクリックすると認可画面に遷移します。
- 遷移後の手順は「ブラウザで認可コード取得する場合」をご参照ください。
- 取得したアクセストークンを使用します。
APIをコールする
- まずは多くのAPIで事業所IDは必須となりますので、その情報を取得します。
- 「api > 1 > companies > 事業所一覧の取得」を開き、「Send」をクリックします。
- response bodyを参照し、事業所ID(id属性)をCollection変数のcompanyIdのValueに入れて、各種APIのリクエストの値にこの変数を利用することをおすすめします。
- 同様の手順で他のAPIもご利用ください。