Box APIをPower Platformから使う
本記事ではM365のプロダクトの一つであるPower PlatformからBox APIを利用する方法について記載します。題材としては、Boxのメタデータクエリを用いて検索を行うアプリを作っていきます。
開発・設定手順を全て説明すると膨大な量になってしまうため、本記事では開発の流れとポイントに触れます。より詳細な手順はこちらの資料を参照してください。また、今回作成するアプリの実際の動きの動画も録画しました。本記事と併せてご覧ください！！
Power Platformとは
M365に含まれるローコードツールの総称です。いくつかのサービスの総称ですが、今回はこのうちワークフロー作成ツールのPower Automateとアプリ開発のPower Appsを利用します。
記載の内容を実装するにはPower Platformの有償ライセンスが必要になる場合があります。ライセンス体系についてはMicrosoft社へお問い合わせください。
Box APIとは
BoxはブラウザでGUIからご利用いただくのが一般的ですが、これとは別にプログラムからもBoxの機能を利用することができます。このインタフェースの一群がBox APIです。
API利用の際に使えるツールとして主要プログラミング言語から使えるSDKもあります。が、Power Automateはプログラミング言語を使わず開発する作りのため、今回はSDKなしで直接Box APIをコールします。
※Box APIを利用するにはBoxのライセンス契約とは別にAPIの契約が必要となります。詳しくは担当営業にお問い合わせください！
開発の流れ
セットアップ
まずBox側の準備としてカスタムアプリを作成します。認証方式は 「OAuth 2.0 (ユーザーまたはクライアント認証)」 を選択します。この設定により、Power AutomateからはBoxの管理対象ユーザーの権限でAPIをコールすることになります。
APIコールの際にはBoxのコラボレーションによってアクセスできるファイル・フォルダが決まり、これはGUIからの利用時と同様です。
カスタムコネクタの準備
Power AutomateはM365の他プロダクト（e.g. Teams, SharePoint）とのコネクターや、サードパーティ製品（e.g. Salesforce, ServiceNow）とのコネクターが用意されています。これらを用いることで比較的簡単にシステム間連動の仕組みを作ることができます。
もちろん、Boxもコネクターが用意されており、ファイルアップロードやコピーなど基本的な機能はすぐに利用できます。
（Boxコネクターのアクションの一部）
一方、コネクターが対応していない機能を使う場合は自らコネクターを定義する必要があります。今回実施しようとしているBoxのメタデータクエリはBoxコネクターが対応していないため、まずカスタムコネクターを作成します。
作成にあたっては、利用するAPIの
- 引数
- 返ってくる結果の形式
の情報が必要です。そのため、APIドキュメントを参照しながらでなければ設定できません。BoxのAPIドキュメントはこちらに公開されています。
(BoxのAPIリファレンス)
APIリファレンスの中のリクエスト本文や例を見ながら、「必須」のパラメータは必ず定義、それ以外については必要であればカスタムコネクターの引数に定義します。同様に、レスポンスの形式を見てアプリで利用したい情報がどのように返却されるかを確認します。
Flowの作成
FlowとはPower Automateで作成する処理の単位で、その名の通りワークフローの定義です。
この辺りの処理をさせます。
- 入力した値の取得
- Box APIのコール
- 結果の取得とApoへの受け渡し
ユーザーに入力をさせる項目と、APIコールに必要な引数がピッタリ一致することはほぼ無いので、適宜ユーザー入力値を引数にあうように加工も必要です。
取得した値は次にアプリ上で表示させるために使うので、こちらも必要に応じて加工します。
（フロー定義画面）
Appの作成
ユーザーが実際に触る画面を作ります。入力欄やボタンはGUIでDrag & Dropで作れます。動作や表示に関しては一部コードを書く必要があります。ちなみにこの部分は全くBoxの知識はほぼ要りません。
個人的な感想ですが、ロジックの組み方はかなりクセがあります。一般的なプログラミング言語と異なり、Excel関数を組み立てるときに近い印象です。慣れるまでは大変かも知れません。また、資料に記載している実装方法は一例ですので、もしもっと簡単な方法があるよ！というものがありましたらぜひ教えてください！
（画面の作成）
終わりに
Power PlatformからBox API利用までの流れをざくっと解説しました。Box APIの知識が必要になるのはカスタムコネクターの作成の部分のみで、これさえ作成できてしまえば、あとはPower Platformの開発と同じです。
ローコード開発プラットフォームのPower PlatformからBoxの様々な機能を使えるようになることで、Boxを用いたいろいろな業務効率化の範囲が広がるはずです！また、実際にPower Platformを用いて開発したアプリの事例もありましたらぜひBoxメンバーにもぜひ共有をお願いします！！