Box連携 〜BoxAPIのアカウント登録、事前準備編〜
こんにちは。
自称）BizRobo!エンジニアのもりりんです。
BizRobo!からBoxにファイルをアップロードしよう 〜概要編〜で説明したロボット開発に入る前の事前準備編を始めていきましょー。
と、その前に注意事項です。
本記事は、Boxアカウントを既に作成している前提で進めます。
アカウントをお持ちでない方は、事前に作成をお願いします。
また、BoxAPI利用の動作チェックにサードパーティ系ツールを利用しています。
利用に関する問題については当社では責任を負えないため、ご自身でお確かめの上ご利用ください。
今回のチャプターです。
- BoxAPIを利用するための情報が載っているサイトを見つける
- 利用方法を確認し、必要な情報を登録する
ではでは、進めていきましょー。
1．BoxAPIを利用するための情報が載っているサイトを見つける
って、BoxAPIを利用すると決めましたが、どうやって利用するの？？？
といきなり躓きますが、順に追っていきましょう。
まずは、BoxAPIを利用するための情報がどこでチェックできるのか探してみましょう。
BoxのHPにアクセスし製品メニューを見ると「開発者ツールとAPI」という項目があり、APIに関する情報はすぐに見つかりそうですね。
このページにアクセスし下の方までスクロールすると「トレーニングコース」といった情報もありますが、今回はこちらを利用せずに更に下の「開発者向けリソース」にアクセスします。
↓↓↓こっち側ですよー↓↓↓ 
そうすると、「Box Dev」と呼ばれるAPIを含むBoxPlatformを利用する開発者向けサイトが表示されます。
他社サービスも同様な構成になっていることが多く、サービスを利用するだけならサービス名を冠する一般サイト、
企業や個人が他社サービスの機能を利用したい場合は、＋開発者向けサイトを利用することになります。
では、メニューに表示されている「Quick Start」から必要な情報が載っている「Postmanを利用したAPI呼び出し」へアクセスします。
2．利用方法を確認し、必要な情報を登録する
WebAPIをBizRobo!で利用する場合は、REST APIに準拠した「REST Web サービス呼出」と呼ばれる機能を利用します。
「REST API」や「REST Web サービス呼出」の説明は割愛しているため、以下の記事を参考にしてください。
※ REST APIとは何かを調べまくったらようやくイメージができてきたのでまとめた
※ REST Web サービス呼出(Call REST Web Service) 」ステップ「引用：BizRobo!ナレッジベース」
Quick Start（お手軽に始める的な）では、画像の手順に従って作業するとAPIを利用できるようなので、下記の手順に沿って作業していきましょー。
１．デバイスにPostmanをインストールする
→既にインストール済みのため割愛します。
Postmanについては、概要編でも紹介している記事等でご確認ください。
はじめてでも怖くない！ Postman を使って、Web API を触ってみよう！
なお、こういったサードパーティ系ツールの利用に関しましては、ご自身で利用に問題ないか調べた上でご利用ください。
２．PostmanからBox APIにアクセスできるようにBoxアプリを設定する。
原文では、以下のように記載されています。
→要約すると、BoxAPIを利用するために必要な「アクセストークン」は、「Boxアプリ」と呼ばれるAPI用アカウントでBoxにログインすることで発行することができます、といった感じでしょうか。
更にPostman利用時は有効期限はなくなるようです。
厳密には、アクセストークンの更新処理が組み込まれたAPIを用いるため、自動更新されます。
そういった機能がない場合、有効期限はアクセストークンの取得後60分となっています。
なお、下部に「まとめ」が記載されていました。
まとめに記載されているOAuth（認証）についての説明は、以下の記事が参考になるかと思います。
では、Boxアプリを登録していきましょう。
新しいアプリが選択されている状態で「アプリの作成」をクリックすると、Boxアカウントにログインを求められます。
小さいダイアログにアクセス許可画面が表示されるため、そちらを許可します。
続いて、作成するBoxアプリの名前（初期値は、Postmanです）を変更し、「Create APP」をクリックします。
Boxアプリの作成が完了すると、元画面に「クライアントID、クライアントシークレット」が表示されていることを確認します。
この2つのテキストは、メモ帳などにコピーしてなくさないようにしてください。（もちろん、外部にも漏らさないこと！）
完了ボタンをクリックして次に進みましょう。
３．Boxアプリにログインして適切なAPI資格情報を取得する。
BoxAPIの利用に必要なアクセストークンを発行するために、BoxアプリがBoxアカウントを操作できるように「Login」から許可設定をします。
Boxアプリの作成時と同様にBoxアカウントのアクセス許可設定画面が表示されるため、許可します。
なお、箇条書きになっている項目がBoxアカウントの操作に関する権限です。
発行されたアクセストークン、更新トークンもメモ帳にコピーしてください。
完了ボタンをクリックして次に進みましょう。
４．PostmanにBoxのPostmanコレクションを読み込む。
この手順はスキップしても問題ありません。
ですが、Postmanに利用できるAPI一覧をインストールでき、サイトよりも確認しやすいので実施しておくと今後の作業が楽になるかもしれません。
「Run in Postman」をクリックすると、Webで起動するか、インストールしたアプリで起動するか確認されますので、利用したい方を選択してください。
アプリ画面の表示となりますが、以下のように「Box Platform API」のAPIセットが自動ダウンロードされます。
作業分類毎にグループ分けされており、必要なパラメータを追加するだけで簡単に利用できます。
５．Postmanを使用してBox APIへの最初のAPI呼び出しを実行する。
この手順はスキップしても問題ありませんが、認証情報をブラウザストレージから削除する操作はしておきましょう。
なお、PostmanにAPIセットを取り込み済みの場合、認証情報も同時に取り込まれているので削除しても問題ありません。
最後にPostmanを利用した「フォルダ情報を取得」するAPIの使い方を簡単にご紹介します。
APIセットの「フォルダ」から「フォルダ情報を取得」を選択します。
①の「認証情報セット」から「Box(〜)」を選択します。
②「Path Variavles」項目の「folder_id」に0を指定します*1。
「Description」列に各パラメータの説明が載っているため合わせて確認ください。
③Sendボタンをクリックして実行し、ステータスが「200 OK」 になっていれば成功です。
以上で事前準備は完了です。
OAuthを利用する際は、リダイレクト用サーバを用意することも多いですが、サービス側で完結できるのはユーザとしては嬉しいことですね。
なお、Postmanの認証情報セットに登録された情報は、本来であれば1時間程度で無効になりますが、Postman利用時は自動更新されるようです。。
もし更新されない場合、、APIセットの「承認」内の「アクセストークンの更新」APIで再発行してください。
思ったより長い説明となってしまいましたが、次編はロボット化に必要なAPIを確認していきます。
ではでは、次にいきましょー。
Next : ロボット化に必要なAPIを検討、仕様確認
※1 folder_id=0は、ルートディレクトリのこと
自己紹介：
猫アレルギーですが、ラグドールを溺愛している猫エンジニア
２匹目探しと猫ハウス化に向けて自宅DIYに奔走中
経歴：
前職は、Web系の基幹システム開発やCS対応を担当
ミュートスでは、スマホアプリ開発やBizRobo!開発/導入支援を担当
現在は、AI開発（見習い）としても活動（2021#2のE資格取得に向けて奮闘中）
イラスト提供：フリーペンシル(https://iconbu.com/)
