メインコンテンツへスキップ
は、フルセットの開発環境を構成しなくても、使いやすいインターフェースでHTTPリクエストを作成およびテストできるツールです。 Box Postmanコレクションは事前設定済みのリクエストをまとめたもので、これにより、リクエストを手動で構成しなくても、Box APIを利用できるようになります。

​
クイックスタート

​
手順1: Postmanをインストールする

お使いのオペレーティングシステム (Windows、Mac、Linux) に適したPostmanアプリをしてインストールします。必要に応じて、。

​
手順2: Boxアプリを構成する

Postmanコレクションを使用するには、Box APIで認証を行うためのBoxアプリが必要です。次の例ではOAuth 2.0を使用していますが、その他の認証方法を使用することもできます。
  1. に移動します。
  2. 次のいずれかを実行します。
    • アプリケーションを選択し、そのアプリケーションで認証方法として標準OAuth 2.0を使用することを確認します。
    • [新規アプリ] を選択した後、アプリ名を入力し、[アプリタイプ] として [OAuth 2.0] を選択します。
  3. [構成] タブで [OAuth 2.0リダイレクトURI] セクションまでスクロールし、[リダイレクトURI] をhttps://oauth.pstmn.io/v1/callbackに設定します。
    デスクトップアプリではなくPostmanウェブアプリを使用している場合は、すべての関連する手順でhttps://oauth.pstmn.io/v1/browser-callbackを使用してください。
  4. [アプリケーションスコープ] セクションまでスクロールして、目的のを選択します。アプリケーションには、以下のスコープのうち少なくとも1つが必要です。
    • Manage users
    • Read all files and folders stored in Box
    • Read and write all files and folders in Box
  5. ページ上部にある [変更を保存] をクリックします。
  6. [OAuth 2.0資格情報] セクションから、[クライアントID] と [クライアントシークレット] をコピーします。

​
手順3: Boxにログインする

前の手順で取得したクライアントIDとクライアントシークレットを使用して、PostmanのOAuth 2.0でBoxの認証を行います。
  1. Postmanで、を作成するか、既存のリクエストを開きます。
  2. [Authorization (承認)] タブに移動します。
  3. [Type (タイプ)] を [OAuth 2.0] に設定します。
  4. Postmanデスクトップアプリを使用している場合は、[Authorize using browser (ブラウザを使用して承認)] を選択します。
  5. [Configure New Token (新しいトークンの構成)] のフィールドを入力します。
フィールド値
Token Name (トークン名)任意の名前 (例: Box Access Token)
Grant Type (許可タイプ)Authorization Code
Callback URL (コールバックURL)https://oauth.pstmn.io/v1/callback ([Authorize using browser (ブラウザを使用して承認)] を選択している場合は自動で入力されます)
Auth URL (認証URL)https://account.box.com/api/oauth2/authorize
Access Token URL (アクセストークンURL)https://api.box.com/oauth2/token
クライアントID開発者コンソールからコピーした、アプリのクライアントID
クライアントシークレット開発者コンソールからコピーした、アプリのクライアントシークレット
スコープ空のままにする
State (状態)空のままにする
Client Authentication (クライアント認証)Send client credentials in body
  1. [Get New Access Token (新しいアクセストークンを取得)] をクリックします。
  2. ブラウザウィンドウが開かれるので、そこでBoxアカウントにログインしてアプリのアクセスを許可します。
  3. 承認後、Postmanはアクセストークンを受け取ります。[Use Token (トークンを使用)] を選択してください。

​
手順4: Box Postmanコレクションをフォークする

下のボタンをクリックして、Box Postmanコレクションを自分のPostmanワークスペースにフォークします。 Boxによる変更が行われた場合に更新を受け取れるように、コレクションを (コピーではなく) フォークすることをお勧めします。コレクションはインポートするとPostmanの左側のサイドバーに表示されます。リソースの種類別に整理された170以上のAPIエンドポイントを探索できます。

​
手順5: Box環境を構成する

Box Postmanコレクションでは、環境変数を使用してAPIリクエストを認証します。コールを実行する前に、コレクションとともにインポートされたBox環境で以下の変数を設定しておく必要があります。
  1. Postmanの左側のサイドバーで、[Environments (環境)] ドロップダウンから [Box] を選択します。
  2. 次のとおりにフィールドに入力します。
変数値
client_id開発者コンソールからコピーした、アプリのクライアントID
client_secret開発者コンソールからコピーした、アプリのクライアントシークレット
grant_typeauthorization_code
  1. [保存] をクリックします。
  2. 次に、承認codeを取得して、アクセストークンと交換する必要があります。コードを取得するには、ブラウザで次のURLにアクセスします。[CLIENT_ID]は実際のクライアントIDに置き換えてください。
https://account.box.com/api/oauth2/authorize?response_type=code&client_id=[CLIENT_ID]&redirect_uri=https://oauth.pstmn.io/v1/callback
  1. ログインしてアクセスを許可します。リダイレクト後、ブラウザのアドレスバーでURLの末尾からcodeパラメータをコピーします。このコードの有効期限は30秒のため、次の手順をすばやく完了してください。
  2. Postmanに戻り、Box環境でcodeを変数として入力し、そのコードを [Value (値)] フィールドに貼り付けます。
  3. [Authorization (承認)] フォルダを開き、[Refresh access token (アクセストークンを更新)] を選択して、[Send (送信)] をクリックします。
  4. 成功した場合は、レスポンスとしてaccess_tokenとrefresh_tokenが返されます。これらをBox環境に入力します。

​
手順6: Box環境をテストする

  1. Box Postmanコレクションで、[Folders (フォルダ)] フォルダを展開し、[List items in folder (フォルダ内の項目のリストを取得)] を選択します。
  2. folder_idはデフォルトで0 (ルートフォルダ) に設定されています。これはそのままにするか、特定のフォルダIDに変更します。
  3. [Send (送信)] をクリックします。
レスポンスの [Body (本文)] タブには、フォルダ内の項目が表示されます。
Postmanから認証エラーが返される場合は、アクセストークンの有効期限が切れている可能性があります。詳細については、を参照してください。

​
追加情報

  • Postmanチームが提供するを確認してください。
  • 自動更新など、してトークンの有効期限切れに対処する方法を確認してください。