BOX
Postman
boxapi

Box APIをPostmanで叩いてみよう

Box APIを試してみたくてもCurlでURLを叩くのがめんどくさい、どういうエンドポイントがあるのかわからない
そんなときは、Postmanを使って簡単にエンドポイントに対してコールを試してみることが出来ます。

Postmanとは

postmanはWebサービスAPIを簡単にテストできるツールになります。
Box APIをpostmanを使って呼び出してみましょう

このドキュメントでは以下が説明されます。

  • Postmanの設定手順
  • Box API初期設定手順
  • Postmanを使ってBox APIを呼び出す

事前準備:

Postmanを使用するのに必要な環境:

Postmanのネイティブクライアント をインストール

(Chrome AppsがEoLを迎えるためネイティブアプリの導入を推奨

②Boxアカウント

(以下の設定を行うとBox API経由でデータにアクセス可能となります。テスト環境での検証を強く推奨いたします。)

Postmanの設定

①Postmanをホームページからダウンロード、インストール

②インストール後、Postmanを起動します。

③postman起動後、アカウントサインインを求められますが、SKIPできます。

④Box APIエンドポイントのインストールを行います

下記リンクをクリックし、変遷後のURLをコピーします
https://cloud.app.box.com/v/postman-box-content

⑤Postmanを起動し、IMPORTボタンを押下し、IMPORT FROM LINK設定にURLを入力します

⑥Collectionタブを選択すると、Box APIエンドポイントがインストールされているはずです。

Box APIの設定

Developer Tokenの取得方法は以下のドキュメントを参照ください。
https://cloud.box.com/s/4inscvj7o04jh1u0kym7ktkawcwwcrth
*以後、API経由でデータが取得出来るようになります。
まずは、テスト環境でのログインを推奨いたします。

①上記で取得した開発者トークンをコピーします

②postmanアプリにの戻り"Usersフォルダ" > Get the Current User's informationを選択します

③Headerタブを選択し、Authorizationキーの値にアクセストークンを挿入します。

例;

④Body欄にJSON形式でユーザ情報が返ってきているはずです。

⑤他のAPIコールも呼び出し方は基本的に同じです。

APIエンドポイントによっては管理権限がないと呼び出せないものもあります。
また、データの呼び出し方の作法を守らないと呼べないものもあります。
各種エンドポイントの呼び出し方法はBox APIドキュメントをご参照ください
日本語:https://ja.developer.box.com/reference
英語:https://developer.box.com/reference

動画