Postmanを使用して5分でBox APIを開始する
Boxでは、Box APIをPostmanユーザーに公開し、定期的にBox APIコレクションを更新しています。
最近、Postmanのツールガイドが更新され、数回のクリックでAPIをPostmanにフォークできるようになりました。引き続きコレクションのインポートだけを行うこともできますが、この方法では、更新されるたびに通知を受け取ることになります。
さらに、必要な場合は、アプリの認証トークンがあらかじめ入力された環境変数一式も提供されます。
それでは、始めましょう。
Postmanコレクションガイドに移動し、左のメニューにある [クイックスタート] を選択します。最初の手順では、Postmanがインストールされていることを確認しますが、オンラインバージョンで問題なく動作します。今回は、v10を使用しています。
新しいBoxアプリを作成するか既存のBoxアプリを使用するかを選択できます。
今回は、既存のアプリを使用します。どちらを選択しても、アプリが標準OAuth 2.0であることと、正しいリダイレクトURLを設定していることを確認してください (ガイドの注意事項を参照)。
開発者コンソールに移動し、アプリのクライアントIDとクライアントシークレットをコピーして、ガイドのページに貼り付けます。
手順に従ってログインしたら、アプリがBoxアカウントを使用することを承認する必要があります。
この承認により、後でアクセストークンと更新トークンを使用してワークスペースに環境変数が作成されるため、作業を開始しやすくなります。
ページの下部にあるガイドを続けましょう。
大きなオレンジ色の [Run in Postman] ボタンが表示されているはずです。そのボタンをクリックすると、ダイアログボックスがポップアップ表示されます。
Box APIコレクションのフォーク先として使用できるワークスペースがあることを確認します。
ここでドロップダウンからBox環境を選択すると、すぐにリクエストの作成を開始できます。ルートフォルダのコンテンツのリストを取得しましょう。
アクセストークンを更新すると、環境変数が更新されるため、コーディングセッションを再開できます。今回は、MacOSのデスクトップアプリを使用します。
Box APIは非常に幅広く、マルチメソッド、65のエントリポイント、複雑なデータ構造が備わっています。
Box Platformでは、APIをカプセル化した複数の言語のSDKを提供していますが、お気に入りのプログラミング言語が提供されていない場合やコードのレイヤーを少なくしたい場合があるかもしれません。
何ができるか模索している場合も、特定のエントリポイントを使用する場合も、Box API Postmanコレクションをいつでも使用できるようにしておくと便利です。
詳細については、Box APIリファレンスを参照してください。
