Box Hubs APIに関連する新しいエンドポイントを発表しました。このBox Platformの強化により、企業全体でコンテンツを整理するためのBoxのソリューションであるBox Hubsをプログラムで管理できるようになります。このAPIにより、コラボレーションやコンテンツの管理、カスタムワークフローへのBox Hubsの統合の新たな可能性が広がります。
Box Hubsの有効化
Box Hubsを使用すると、組織内の特定のチーム、部門、またはプロジェクトのコンテンツを1か所にまとめて整理することができます。Box Hubsは、ファイル、フォルダなどのリソースを簡単にアクセスできる構造化された方法でまとめるコンテンツポータルとして機能します。
Box AIとも統合されているため、コンテキストウィンドウを絞り込むことで、応答の精度を高めることもできます。企業全体でBox Hubs (APIを含む) を有効にするには、こちらの製品ガイドに従ってください。
Box Hubs API
APIを使用して、Box Hubs関連の複数の操作を実行できるようになりました。現在、利用可能なエンドポイントのグループは3つあります。Box Hubsの管理、Hub内のコンテンツの管理、コラボレーションの管理に関連する、考えられる操作を見てみましょう。
Box Hubs APIのエンドポイント
まず、Box Hubsの管理に関連する操作について説明します。このカテゴリには7つのエンドポイントがあります。
- GET: 企業のすべてのHubのリストを取得 (このコールは、GCMスコープが設定されている、企業の管理者またはHub共同管理者が実行できます)
- GET: ユーザーのすべてのHubのリストを取得
- GET: IDを指定してHubを取得
- POST: Hubを作成
- POST: Hubをコピー
- PUT: Hubを更新
- DELETE: Hubを削除
APIを使用して最初のHubを作成します。必須パラメータは、Hubのtitleとdescriptionの2つだけです。この操作では、APIの探索にBox Postmanコレクションを使用します。
成功したレスポンスでは、新しく作成されたHR Hubに関連付けられた追加情報が提供されます。Box Hubsのウェブインターフェースを更新すると、このHubにアクセスできるようになります。現時点で、このAPIはHubのスタイル設定をサポートしていないことに注意してください。ただし、所有者はBoxウェブアプリを使用してスタイルを編集できます。
デフォルトの設定でHubが作成されます。PUTメソッドを使用して追加のパラメータを渡すことにより、APIを介してHubを更新およびカスタマイズできます。
もう1つの便利なエンドポイントは、企業内のすべてのBox Hubのリスト取得に関連しています。updated_atまたはview_countパラメータでフィルタをかけて、使用されなくなったHubを絞り込むことができます。パラメータの詳細な説明やさまざまなプログラミング言語のコードサンプルについては、APIの仕様を確認してください。
Box Hubsの項目APIのエンドポイント
次に、APIを使用したHub内のコンテンツ管理に関連する別のエンドポイントグループを見てみましょう。現段階で、APIはファイル、フォルダ、ウェブリンクの管理をサポートしています。吹き出し、区切り線、段落、セクションなどの残りの要素は、Box Hubsのウェブインターフェースの編集モードを使用して手動で追加する必要があります。
Hub内のコンテンツに関連する操作をサポートするエンドポイントは2つあります。
- GET: Hubのすべての項目のリストを取得
- POST: Hubの項目を追加または削除
Hubにファイルを追加する簡単な例を次に示します。
現段階では、コンテンツを追加できるのは最初のコンテンツブロックです。そのため、Box Hubsのインターフェースを使用して既存のブロックが2つ追加されている下のスクリーンショットの場合は、APIを使用して追加されたTestPDF2が、最初のコンテンツブロック内でGoogleスライドのプレゼンテーションのすぐ下に配置されました。一方で、例えば、2番目のブロックから項目を削除することは可能です。207のステータスコードが返されます。
前述のエンドポイントを利用する興味深いユースケースとして、Box検索APIなどを利用したBox Hubの新規作成の自動化が考えられます。メタデータクエリを使用して特定の条件に一致するすべてのコンテンツを識別し、Hubの項目を作成するエンドポイントを使用して、フィルタがかけられたコンテンツをHubに追加できます。
別の興味深いユースケースとして、SIGN_REQUEST.COMPLETEDなどのイベントがトリガーされると、Hubに特定のドキュメントセットが追加されるという例も考えられます。Webhookの詳細については、開発者向けガイドをご覧ください。
Box HubsコラボレーションAPIのエンドポイント
最後に、Box Hubsのコラボレーションの管理に関連するエンドポイントは5つあります。
- GET: HubのすべてのHubコラボレーションのリストを取得
- GET: Hubコラボレーションの情報を取得
- POST: Hubコラボレーションを作成
- PUT: Hubコラボレーションを更新
- DELETE: Hubコラボレーションを削除
次のcURLリクエストのサンプルでは、ユーザーIDを使用して、viewer権限を設定した新しいHubコラボレーションを作成しています。
このエンドポイントは、オンボーディングの自動化スクリプトを強化するためのツールとして役立ちます。もう1つの面白いユースケースとして、Box Groups APIを利用して、admins_onlyなどの特定のユーザーのみにフィルタをかけ、特定のHubにコラボレーションを追加することが挙げられます。
Box Hubsからのインテリジェントなコンテンツインサイトの取得
この記事の冒頭で説明したように、Box AIを使用してBox Hubsにクエリを実行できます。厳選されたコンテンツから、さらに精度の高い応答でインサイトを得ることができる非常に強力な機能です。こちらの簡単なチュートリアルをご覧ください。
カスタムポータルへのBox Hubsの埋め込み
Box Hubsはウェブアプリに直接埋め込むことができます。このソリューションにより、ネイティブのBox AIエクスペリエンスも実現します。iframeコードスニペットを生成して、ウェブアプリのソースコードに直接貼り付けることができます。詳細な手順については、以前のブログ記事をご覧ください。
新しいBox Hubs APIには、開発者がBox Hubsを自動化したり、アプリケーションやワークフローに統合したりするための強力な機能が用意されています。これらのAPIを使用すると、従業員のオンボーディングの効率化、部門リソースの管理、コンプライアンスの確保など、組織のニーズを満たすカスタムソリューションを柔軟に構築できます。
今回の新機能をぜひ構築にお役立てください。
🦄 Box Platformの他のエキスパートと交流したい場合は、サポートや知識共有のためのBox Developer Community (英語のみ) にご参加ください。