Box APIを使ってみたいけど、何から始めたらいいのかわからないという方いらっしゃいませんか？本セミナーでは簡易的なWebアプリケーションをセミナー内で作成することで、アプリケーションの作成手順をご説明します。初級編の内容はこちらのページで公開しています。
★対象となる方：
-
BoxAPIを活用したい業務イメージがある方
-
BoxAPIの活用を今後進めていきたい方
-
コーディングを実施したことある（必須ではない）
-
他のサービスでAPIを作成したことがある（必須ではない）
-
アジェンダ
- Box APIとは
-
実際に作ってみよう（セミナー内でサンプルアプリを作成します）
-
開発者アカウントの発行
-
アプリ設定
-
アプリケーション開発
-
-
APIを利用した実例のご紹介
-
Platform開発を支援するBox Consultingメニューのご紹介
動画
資料
Q&A
セミナーに寄せられた質問とその回答を記載します。回答は2023年10月時点の情報をもとにしています。
|
AUアカウントは、ライセンスを,消費しますか？
|
AUアカウントはライセンス消費しません。ただしサービスアカウントはライセンス(ユーザー数)を消費します。 課金の観点では、AUをご利用の場合、月間アクティブユーザー数（MAU＝AU＋SA）は課金対象になります。Box Core ライセンスで使用可能な月間MAU 数の上限値を超過する場合には課金対象になります。詳細は弊社営業にご確認をお願いします。 本番環境でSAやAUを使うためには、Platformオプションを購入いただく必要があります。 （ちなみに正式には、Platformオプションを購入できるのはEnterpriseエディション以上です。） その上で、月間に何人のAU／SAを利用したのかというマンスリーアクティブユーザー（MAU）と、APIのコール数により課金がくが見積もりベースで決まります。 APIは多くのエディションで月間１０万コールまでバンドルされていますので、これを超える分が課金対象となります。 ただし、この課金は（大量の実行でないかぎり）本番での利用の場合のみです。 テストや開発においては課金はありませんし、BoxのエディションもEnterpriseである必要はありません。 |
|
Postmanとの認証もJWTで設定可能でしょうか？ |
はい、JWT認証でも設定可能です。 PostmanはAPIを呼び出すだけですので、JWTも不可能ではないのですが、JWTアサーションという文字列を作成して送信することが大変です。 もしJWTを利用したい場合は、Postmanではなく、BOX CLIを使っていただくべきかとおもいます。 |
|
開発を別会社に委託する場合、自社のテナントでBoxアカウントを開発者用に追加で用意する必要はありますでしょうか。 |
開発のスタイルにもよりますが、もし御社のテナントでアプリケーションを作成し、開発者の方がフリーアカウントや、別テナントのアカウントをおもちの場合は、アプリケーションの一般設定にある「コラボレーター」に追加していただくことで、自社テナントにアカウントを用意しなくても、開発者やテスターの方が、自社テナントで作成したアプリケーションを利用することが可能です。 別会社に開発して貰う場合は、多くの場合、いかのような構成で開発されている用に思います。 １．貴社テナントの１ユーザーとしてMUを発行し、本番環境で開発してもらう（仰られている方式） ２．貴社テナントでサンドボックスを作成し、そのサンドボックスの管理者または一般ユーザーとして別会社の方に開放する ３．別会社の方が、トライアルテナントまたは別会社の方が所有するBOXテナントで開発を行う
それぞれ一長一短あると思いますが、本番環境と切り分けたい場合、２または３の方式が良いかと思います。 逆に、本番につなぎながら迅速に保守を行っていきたい等の場合は、１の方式をあえて選ぶメリットもあろうかと思います。 |
|
BOXへファイルをアップロード・ダウンロードを行うWebアプリ（PHP）を開発予定です。その際、最適な認証方式はOAuth2.0になりますでしょうか。 |
人間が介在してファイルをアップロード/ダウンロードをする場合はユーザー認証(OAuth2.0)をご利用ください。 スクリプトで自動的に別のシステムからBoxへアップロード/ダウンロードを行うようなものを作成される場合はサーバー認証(OAuth2.0)をご利用ください。 追伸:もし、人間が介在する場合でも、ユーザー様がBoxのアカウントを持っていない場合はApp User(AU)を利用する必要がございます。その場合はサーバー認証（OAuth2.0)をご利用いただき、サーバー認証型のアプリをテナントで許可した際に作成されるサービスアカウントにてApp User(AU)を作成していただき、サービスアカウントからApp User(AU)のアクセストークンを発行します。 そのアクセストークンをBox UI Element等に渡すことで実現することが可能です。 どの認証を使うかは、開発言語ではなく、どのユーザーアカウントを使うのかという観点でお選びください。 ユーザー認証（Oauth2.0)を利用する場合、必ず、利用するユーザーアカウントはMUとなります。 つまり、すでに社内でBOXにアクセスできる人のための、社内用アプリをつくる場合にご利用していただけます。 Boxにアカウントを持たない人に使わせるアプリで、ファイル置き場にBOXを使いたい場合、SAやAUがつかえるサーバー認証を選んでいただくことになります。 PHPむけの公式SDKがありませんので、クライアント資格情報許可という方式のIDとパスワードでSAの認証を行う方式を使っていただくのが良いかと思います。 |
|
主旨と異なるかもしれませんが、BoxAPIでしかできない操作はありますか？ また、APIを活用してお客様に喜ばれている利用方法などありましたら教えてください。 |
これは例となりますが、Folder LockのAPIがそれに該当します。Folder LockはAPI以外では実行することができません。 Folder LockのAPIはお客様の間違えたフォルダーの削除や移動等の誤操作を防ぐことができるため、喜ばれるAPIでもございます。
また、APIは組み合わせて利用することで、面倒なことや、BoxのWeb画面では実現できないことを行うことができますが、お客様のユースケースによって喜び方は変わってくるため、ぜひとも都度、弊社Boxコンサルタントにご相談をいただければと思います。 |
|
フォルダのロックを行いたいのですが、 開発のメニューのアプリケーションスコープはどこにチェックが必要でしょうか？ |
'- Boxに格納されているすべてのファイルとフォルダの読み取り - Boxに格納されているすべてのファイルとフォルダへの書き込み
の2つの権限があれば利用可能です。 |
|
GUIでメタデータ検索をした場合、1検索当たりどのぐらいAPIコールを消費しますでしょうか。 |
原則、1検索1APIコールです。ただし、結果が多く1APIコールで全ての結果を取得できない場合は、複数APIコールが必要になる場合があります |
|
管理者操作の項目は設定不要で問題ないでしょうか。 |
フォルダーロックAPIについてのご質問でしょうか。それならば、管理者操作については必要ありません。 |