Postmanでリクエストを行う

アプリケーションの作成の次のステップ

ここでは「Postman」を利用してAPIリクエストを行う際の手順を紹介します。

Postmanとは

  • Postman」は一から開発環境を構築せずに、簡単にHTTPリクエストを作成・テストできる開発者向けのツールです。
  • freeeは “Collection” と呼ばれる形でAPIをPostmanで公開しており、これを利用することで簡単にfreee会計・freee人事労務のAPIを利用することができます。
  • PostmanのCollectionについて

PostmanでCollectionをforkする

  1. postman.com のアカウントにサインアップまたはログインします。
  2. freee Public API Workspace にアクセスし、Collectionをforkします。

認証設定を行う

  1. アプリケーションを作成する」で作成したOauthアプリケーションにコールバックURLを設定します。
    • 「https://oauth.pstmn.io/v1/browser-callback」 を設定します。
  2. OauthアプリケーションのClient ID/SecretをCollection変数に設定します。
  3. アクセストークンを取得します。
  4. 取得したアクセストークンを使用します。
    • MANAGE ACCESS TOKENSで「Use Token」をクリックします。

APIをコールする

  1. まずは多くのAPIで事業所IDは必須となりますので、その情報を取得します。
    • 「api > 1 > companies > 事業所一覧の取得」を開き、「Send」をクリックします。
  2. response bodyを参照し、事業所ID(id属性)をCollection変数のcompanyIdのValueに入れておくことをおすすめします。
    • 事業所IDが必要なAPIにはこの変数がデフォルトで設定されています。
  3. 同様の手順で他のAPIもご利用ください。