Box APIを使ってみたいけど、使い方が分からない、何から始めたらいいのかわからないという方、いらっしゃいませんか?
Box APIの概要から管理コンソールの設定方法など初心者の方でもわかりやすく解説をさせていただきます。また、実際にBoxの運用で活用できそうなAPIについても紹介します。
アジェンダ
- Box APIとは?
- 利用を開始するためには
-
APIを実行してみよう
- Postmanを使ってフォルダロックAPIをやってみる
- Postmanを使ってコラボレーション一覧を出力してみる
- BoxCLIを使ってコラボレーション一覧を出力してみる
- 質疑応答
動画
資料
関連コンテンツ
質疑応答
当日、参加者のみなさまからいただいた質問と回答一覧を公開します。(以下の情報は2022年11月時点のものとなります)
質問 |
回答 |
フォルダロックされていることを視覚的に確認することは可能でしょうか? |
残念ながら、フォルダロックについてはWeb画面等から確認することはできません。 ただし、APIからロックがかかっているかをチェックすることが可能ですのでそちらをご利用ください。 |
複数のフォルダにロックをかけたい場合は、フォルダ1つずつPOSTMANで作成が必要でしょうか? |
はい、各フォルダーに対するAPIロックのリクエストは各フォルダーに対してかけていただく必要がございます。もし、大量にロックしたいフォルダーがある場合はPostman等ではなく、Box CLI + Power Shell, もしくはPython等のSDKをご利用いただき、フォルダーロックをかけていく必要がございます。 |
フォルダロックは下層フォルダにも有効になるのでしょうか? |
フォルダーロックについては下層フォルダについては対象外となります。お手数ですが各フォルダーにロックを掛けるようにしていただくようお願いいたします。 |
複数フォルダを一括でロックする事は可能でしょうか。 |
フォルダーロックは一括では行うことができません。各フォルダーに対してロックのAPIを実行して頂く必要がございます。 |
先ほどのpostmanでのデモについてですが、フォルダロック等postmanでの制御はBoxDriveに対しても有効でしょうか。 |
はい、ロックされたフォルダーについてはBox上で移動、または削除できない状態となりますのでBox Drive上でも有効となります。 |
APIでフォルダやファイルのIDを参照していますが、フォルダやファイルの名前からIDを取得するにはどうすればいいでしょうか? 説明が足らずすいません。APIベースでどのような手順になるかをお聞きしたかった次第です。 |
ファイルやフォルダのリンクからも取得できます。 例えば、ファイルのリンクはhttps://xxxx.box.com/file/123456789 であれば、123456789はそのファイルのIDになります。 実は一発で取得できる方法がございません。検索APIの結果から探すか、フォルダ配下のアイテムを一度リストしてその中から探す、などの方法があります https://ja.developer.box.com/reference/get-search/ https://ja.developer.box.com/reference/get-folders-id-items/ |
上層のフォルダを指定して、サブフォルダすべての「ロックされているかどうか」のステータスを抽出することは可能でしょうか。 |
ロックの一覧取得のAPIについて、そのサブフォルダーがロックされているかを確認することはできません。お手数ですが、ロックされているかは各フォルダーIDを指定して頂く必要がございます。 |
Box CLI で、POSTMANでいう[folder_locks]を連続実行したい場合、 [folders:locks:create Create a lock on a folder]を[--bulk-file-path]でcsvを指定して使えばいい、ということでしょうか? |
ご記載の通りです。CSVの一行ずつ連続で処理が実行されます |
BoxCLIでは、メタデータやタグ情報もCSVで取りだし可能でしょうか。 可能であれば、そのCSVを更新したり、列を追加したりした情報を元のファイルにもどしてメタデータを上書きすることはできますか? ・メタデータはfiles:metadata のヘルプをみれば何ができるかわかりますでしょうか?
・これらをコマンドが使えない社員がGUIでWebアプリとして作成するにはどのような環境が必要でしょうか?あるいは御社のコンサルディングサービスの利用が可能ですか? |
CLIを実行する際に--csvというオプションをつけると結果がCSVで出力されます。 取り出したCSVを更新・整形して、例えばbox files:metadata:update ID のコマンドの--bulk-file-pathに入力すればメタデータの更新が可能です ・メタデータ自体の概要はこちらを参照いただければと思います。作成までの方法と使い方(主に検索)が搭載されています https://ja.developer.box.com/guides/metadata/
・一般にWebアプリを作る環境と同じかと思います(アプリケーションサーバ等) コンサルサービスをご利用いただくことでこの辺りも支援いたします |
PostmanやBox CLIは別途利用料金がかかりますか? |
Postman,Box CLIの利用自体については費用はかかりません。ただし、Box APIについてはエディションや利用形態によって呼び出せるAPIコール数が制限されています。詳しくは弊社Boxコンサルティングにお問い合わせをお願いいたします。 |
Box UI Elementsで先ほどのフォルダロックするようなUI機能をつくることは可能でしょうか? |
はい、Content Pickerを利用することで実装することが可能です。 https://ja.developer.box.com/guides/embed/ui-elements/picker/ 追記: ただし、Folder Lock自体を行うこと、FolderLockを行うためのUIはご自身で実装して頂く必要がございます。 |
写真画像のExifデータを読み出すようなことは可能でしょうか。 |
画像自体に含まれているデータ・メタデータはBoxの外で別途取得する必要があります。ただ、取り出した情報をBoxファイル上のメタデータとして付加すれば検索等に使うことができます |
Box UI Elementsの利用は、無料でしょうか? |
はい、Box UI Elements は無償でご利用いただけます。 |
APIの利用制限はありますか?回数等... |
はい、APIのコール数については制限がございます。もし、お使いのエディション以上のAPIコールを行う場合は弊社Boxコンサルティングにお問い合わせをお願いいたします。
下記にエディションごとのAPIコール数が乗っているURLを添付いたします(月当たりのAPIコールを御覧ください)。 |
Box UI Elements を利用してAPI連携を行った場合、連携システム側でのBox製品の認証は、どのように認証するのでしょうか? |
Box UI Elementsの場合は、管理対象ユーザーが利用されることが多いかと存じ上げます。その場合はユーザー認証型のアプリケーションをご利用いただければと思います。
もし、Box Platformのサーバー認証型のアプリにて利用可能なApp Userを利用したい場合は、サーバー認証型のアプリを作成後、サービスアカウントからApp Userのアクセストークンを払い出すことも可能です。 詳しくは弊社Boxコンサルティングにお問い合わせをいただければ幸いです。 |
コンサルティングサービスはBoxを代理店契約していても利用できますか?費用を教えてください。 |
はい、ご支援させていただきます。ご要件に応じて、見積りしますので、後ほどお聞かせいただければと思います。因みに、費用は、代理店経由でお伝えする形式になりますこと、ご承知おきくださいませ。引き続きよろしくお願いします。 |
box cli を使って、ファイルのアクセス統計を取得したいのですがAPIありますでしょうか? |
申し訳ございません。アクセス統計を取得するAPIのご用意はございません。 |
csvでBulk実行する際のヘッダー部の命名ルールは --helpで出せますか? |
はい。—helpでだせます。 例えば、box folders:collaborations —help をみると、
USAGE $ box folders:collaborations ID
のようになっています。 この場合、CSVに「ID」という列をつくることで取り出してつかってくれます |
フォルダ名称の変更を認めないAPIはありますでしょうか? |
実はございません...フォルダロックは移動と削除のみ禁止となっており、フォルダ自体に編集者以上の権限があれば名称変更ができてしまいます。 |
APIコール数が,プランの上限に達した場合,APIを実行した際どのようなエラーが返されますか? |
APIコール数の上限を超えた場合でも、エラーがでることなく実行が可能です。しかし上限を超えて継続してご利用頂いている場合、弊社CSM等よりご利用されているエンタープライズ環境の担当者の方にご連絡をさせていただくことがございます。ご了承ください。 |
フォルダロックのようにAPIでしか操作できないコマンドの一覧などはありますでしょうか。 |
詳しくは弊社のデベロッパーサイトのAPI Referenceを御覧いただければと思います。 |
フォルダのコラボレータに関する処理として、メンバー情報を収集するだけでなく、追加や削除はできるのでしょうか。 その場合、上位のフォルダーの権限継承はどうなるのでしょうか? |
可能です。CLIだとbox folders:collaborations:add IDなどのコマンドになります
コラボレーションを追加されたフォルダとその配下にあるファイル・フォルダに継承されます。追加されたフォルダの上には影響がありません。また、継承を切るようなコラボ削除はできません |
フォルダのロックを設定した場合、フォルダ名の変更もできなくなりますでしょうか |
フォルダのロックは移動と削除のみ禁止され、名称変更はできる状態となります |