Boxアプリの設定

Boxアプリの設定

Postmanコレクションを使用するために、Postmanアプリケーションはアクセストークンを使用してBox APIから認証を受ける必要があります。アクセストークンを取得するには、Boxアプリを使用してBoxにログインする方法が最も簡単です。

Boxアプリは、API呼び出しの実行に使用できるアプリケーションです。Postmanコレクションを使用する際は、独自のBoxアプリを設定するか、あらかじめ設定されているBoxアプリを使用するかを選択できます。独自のBoxアプリを設定した場合の主な利点は、1時間ごとにログインする必要がなくなることです。ただし、設定にいくつか追加手順が必要になります。

使用するBoxアプリの選択

独自のBoxアプリを使用する

この方法を使用すると、60日間に1回以上アプリを使用すれば、Postmanでは無期限にBoxへのAPI呼び出しを行うことができます。

この方法では、初期設定の手間が少し増えますが、Postmanがいつまでもアクセストークンを最新状態に保つことができるため、メンテナンスの手間は少なくなります。

あらかじめ設定されているBoxアプリを使用する

この方法を使用すると、Postmanは、BoxへのAPI呼び出しを実行できるようになりますが、1時間が経過すると、このガイドを再度実行する必要があります。

この方法では、初期設定は少なくて済みますが、アクセストークンを自動的に更新することはできません。1時間ごとにこのガイドに戻ってアクセストークンを更新する必要があります。

Boxアプリの作成

独自のBoxアプリを使用するには、Box開発者コンソールで新しいBoxアプリを作成する必要があります。

Boxアカウントを持っていない場合は、テスト用の無料のDeveloperアカウントにサインアップすることができます。

  1. 開発者コンソールに移動します。
  2. [アプリの新規作成]を選択します。
  3. 作成するアプリケーションの種類として[カスタムアプリ]を選択し、[次へ]をクリックします。
  4. 認証方法として[標準OAuth 2.0]を選択し、[次へ]をクリックします。
  5. Boxアプリに一意の名前を付け、[アプリの作成]をクリックします。
  6. [アプリの表示]をクリックしてアプリの設定に移動します。
  7. [OAuth 2.0リダイレクトURI]の設定まで下にスクロールし、[リダイレクトURL]に値https://developer.box.com/auth/callbackを設定します。
  8. 必要に応じて、同じ画面の[アプリケーションスコープ]セクションまでスクロールし、このアプリケーションに対して有効にする必要がある追加の権限を選択します。
  9. ページ上部にある[変更を保存]ボタンをクリックします。

API資格情報のコピー

Boxアプリを作成したら、Boxアプリの[OAuth 2.0資格情報]セクションまで下にスクロールし、[クライアントID]と[クライアント機密コード]をコピーして下のフィールドに貼り付けます。

これらの資格情報は、次の手順でアプリケーションの認証に使用します。

セキュリティに関する注意

API資格情報は、ブラウザキャッシュに保存されています。このガイドで後から出てくるリセットボタンをクリックして、この情報を消去することを強くお勧めします。

まとめ

  • 独自のBoxアプリの使用を選択し、以下の操作を行いました。

    • Developerアカウントにサインアップ(必要な場合)
    • 開発者コンソールにアクセス
    • OAuth 2.0認証を使用するカスタムアプリを作成
    • アプリケーションのリダイレクトURLを設定
    • クライアントIDクライアント機密コードをこのページにコピー
  • または、あらかじめ設定されているBoxアプリの使用を選択しました。