Box Postmanコレクションの更新
開発者の皆さん、こんにちは。
Box REST APIの操作は、便利なPostmanコレクションで簡単に行えます。事前に構成されたバンドルにより、リクエストを手動で作成する時間と手間が省かれるため、Boxの開発作業をすぐに開始できます。
コレクションを手動で作成する無駄な時間をなくす
使用可能なBox Postmanコレクションは2つあり、それぞれが異なるニーズに対応しています。
- Box Platform API (従来のコレクション): 初心者に最適なこのコレクションは、OAuth認証をサポートし、トークンの自動更新に対応しています。
- Box Platformの高度なコレクション: この強力なコレクションは、すべてのBoxアプリケーション認証モード (開発者トークン、OAuth、CCG、JWT) を処理し、トークンの自動更新 (開発者トークンを除く) に対応しています。
利用しやすいように、どちらのコレクションも英語版と日本語版が用意されています。
簡単な設定: 数分で開始
従来のコレクション:
- クイックスタートガイド: Boxの総合的なガイドでは、Postmanのインストール、Boxアプリケーションの作成、コレクションのフォーク、最初のAPIコールの実行など、すべてを説明しています。シームレスな認証のためのPostman環境も設定できます。[クイックスタートガイドへのリンク]
- 動画によるチュートリアル: 視覚的なアプローチをご希望の場合は、設定プロセスを紹介する動画のガイド (英語) をご覧ください。[動画によるチュートリアルへのリンク]
高度なコレクション:
- フォークとカスタマイズ: 公開されているBoxのワークスペースに移動し、コレクションを自分のワークスペースにインポートするだけです。Utilitiesフォルダには、環境の設定を効率化するためのヘルパーメソッドや手順が用意されています。[コレクションへのリンク]
- OAuth認証 (必要な場合): アプリケーションでのOAuthの使用を承認するための明確な手順を含めました。
コレクションを最新の状態に保つ
Boxでは、継続的な改善を信条としています。APIの仕様は常に更新されるため、Postmanコレクションも更新されます。変化に乗り遅れないようにするための方法を以下に示します。
- [Watch original collection (元のコレクションをウォッチする)] を有効にする: これにより、更新が利用可能になったときに通知を受け取ることができます。
- 変更をプルする: 1回のクリックで、簡単に最新の更新をコレクションに統合できます。
新機能については Boxに任せてください
コレクションは、Boxの新機能を反映するよう常に進化しています。たとえば、最新の更新には、待望のAIエンドポイントが含まれています。
従来のコレクションと高度なコレクション: 適切なコレクションの選択
自分に合ったコレクションがわからない方のために、詳しく見ていきましょう。
- 従来のコレクション: 初心者や主にOAuthを使用している方に最適です。
- 高度なコレクション: 柔軟性を必要とする開発者に最適です。複数の認証方法、ユーザー、サービスアカウントをサポートしており、ワークフローの効率化のために簡単に環境を作成して切り替えることができます。
どちらのコレクションにも同じAPIエンドポイントが用意されているので、各自のニーズに合わせて選択してください。
Boxの開発を効率化する準備ができたら
自分に最も適したPostmanコレクションを入手して、今すぐBox APIをご確認ください。
POST/CON 24
日本時間2024年5月2日に、Postmanの開発者向けカンファレンスで高度なコレクションの認証について発表し、同時に行われる認証モードの実装方法について説明しました。プレゼンテーションの動画 (英語) はこちらです。
アイデア、コメント、フィードバックがある場合は、コミュニティフォーラム (英語のみ) にコメントをお送りください。
