クラウド型 ワークフロー

Box OAuth2.0 設定について

Box の API を使うための準備をしよう!

こんにちわ!矢作です!

 

とある営業部長(私のこと)は、営業部の業務改善に奮闘中!

 

「見積承認フローの改善奮闘 – 見積書PDF自動生成 –」という記事で、営業マンの見積申請が承認されると自動的に見積書 PDF ファイルが生成される仕組みを作りました。この見積書 PDF ファイルが自動的に Box に保存されると嬉しいな、と思っていろいろと情報を集めて整理しました。

 

見積書 PDF ファイルが自動的に Box に保存されるようにするには、Questetra のアドオンを使って簡単に実現できます。ただ、そのアドオンを使うためには、Box の OAuth2.0 に関する設定がひとつのハードルになるので、この設定の手順について詳しく書くこととしました。

クラウド型ワークフロー Questetra BPM Suite を利用

 

本記事では、Box への連携を試すのですが、クラウド型ワークフロー「Questetra BPM Suite」を使って進めます。

 

「Questetra BPM Suite」上で利用していただけるアプリもダウンロードできるようにするので、実際に使ってみたい!と言う人は、Questetra BPM Suite 無料版をお申込みください。

 

Box へのアクセスについて

 

Box はクラウド型のファイルサーバです。インターネットに接続することができれば、会社などの組織内で簡単かつ安全にファイルの共有が行なえます。Box では、ファイルをアップロードしたり、アップロードされているファイルの情報を取得したり、ダウンロードしたりすることができます。また、他の組織に所属する人とシェアしたりすることも可能になります。

 

通常は、ファイルのアップロードなどの作業は、ユーザがログインして Web ブラウザの画面上から行うのですが、Box の API を利用して、他のシステムから自動的に行う方法もあります。例えば Questetra で見積承認された後、見積書PDFファイルが生成されると “自動的” に アップロードされるようにするには、Box の API を利用します。

 

Box の API は誰にでも利用できるものではなく、利用しようとするシステムが、事前に利用しても良いという許可を得ていることが必要です。事前に許可を得るための仕組みに OAuth2.0 というものがあり(正しい説明では無いかもしれません!)、Box のAPIを利用するためにはこの OAuth2.0 の設定を最初に行わなければなりません。

 

Box の API を利用するための OAuth2.0 設定

 

Questetra から Box の API を利用するための OAuth2.0 の設定手順を具体的に説明していきます。大まかな流れは次のとおりです。

 

  1. Box で「アプリ」を作成する
  2. Questetra で「OAuth2.0」設定を行う

 

Box で「アプリ」を作成する

 

それではまずは Box で「アプリ」を作成しましょう。Box の管理者ユーザでログインし、次のURLにアクセスします。

 

https://*****.app.box.com/developers/console

 

***** の部分は、ご自身が Box をご利用になる時に使用する URL のものに置き換えてください。この URL にアクセスすると「Box Platformにようこそ!」という画面が表示されます。

 

 

「アプリの新規作成」ボタンを押すと、3種類のうちどのタイプのアプリを作成するのか選ぶ画面が表示されます。ここでは一番右の「パートナーの統合」を選びます。

 


「次へ」を押すとアプリの名前を入力する画面が表示されるので適当な名前を入力します。画面では「file-operation-by-questetra」としていますが、お好きな名称で構いません。入力したら「アプリの作成」を押します。

 

 

完了画面が表示されたら、「アプリの表示」ボタンを押します。

 

 

アプリの詳細が表示されますが、この画面で OAuth2.0 設定に関する情報の入力と、確認(メモ)を行います。まずは、「OAuth2.0 リダイレクトURI」に次のような値を入力します。

 

有償版のQuestetra を利用している場合は、https://s.questetra.net/oauth2callback を、無償版のQuestetraを利用している場合は、https://f.questetra.net/oauth2callback を入力します。

 

 

もし、「OAuth2.0 リダイレクトURI」がどこにあるのか分からなくなってしまった場合には、次の手順で「OAuth2.0 リダイレクトURI」を入力する場所を見つけてください。

 

  1. 最初にアクセスした次のURL https://*****.app.box.com/developers/console へアクセス。
  2. 作成したアプリをクリック。
  3. 左のメニューにある「構成」をクリック。
  4. 「認証方法」で標準OAuth 2.0 (ユーザー認証)が選ばれていることを確認。選ばれていない場合にはクリック。

 

ここまで進めると、「OAuth 2.0リダイレクトURI」が表示されます。

 

そして、「OAuth 2.0リダイレクトURI」の一つ上にある「OAuth2.0資格情報」という所に書かれているクライアントIDとクライアント機密コードをそれぞれどこかにメモしておきます。

 

 

Questetra で「OAuth2.0」設定を行う

 

次に Questetra にログインして、これから Box に連携させるためのアプリをひとつ作成します。アプリ作成権限を持つユーザでログインし、右上の名前をクリックして表示される「アプリ設定」をクリックします。次の画面で「新規作成」ボタンを押して、アプリの名前を適当につけます。

 

「プロセスモデラー」が起動されますが、これをすぐに右上の閉じるボタンを押して終了させます。次の画面で、少しわかりにくいのですが、「▼アプリ」というボタンを探します。見つかったら「▼アプリ」をクリックして表示される「OAuth 2.0 設定」をクリックします。

 

表示された画面の左上の方にある「+追加」をクリックします。表示された画面で次のように入力を行います。

 

  • 名前
    • なんでもOKです。ここでは box としました。
  • 認可エンドポイントURL
    • https://account.box.com/api/oauth2/authorize
  • トークンエンドポイントURL
    • https://api.box.com/oauth2/token
  • スコープ
    • 空のままでOK
  • クライアントID
    • Boxアプリで “メモ” したクライアントID(OAuth2.0資格情報)
  • クライアントシークレット
    • Boxアプリで “メモ” したクライアント機密コード(OAuth2.0資格情報)

 

 

入力を終えたら保存ボタンを押し、「OAuth 2.0 設定」画面に戻ります。この画面で、「トークンの取得」ボタンを押します。

 

 

すると次のような Box の画面が表示されますので、「Boxへのアクセスを許可」をクリックします。(BoxへログインするためのIDとパスワードが求められる場合があります)

 

 

うまく処理がされると次のような画面になり、これで OAuth2.0 に関する設定は全て終了ということになります。

 

 

ここまでで Box API を使ってファイルのアップロードなどをする準備を終えました。

 

Box の API を利用するための詳しい説明は、ここで書かれてます。ただし、全て英語であるため、この記事での紹介が少しでもお役に立てるのではないかと思っています。

 

今後の記事で、Questetra のアドオンを利用して見積書 PDF ファイルが自動的に Box にアップロードされる仕組みを作っていきます。

 

今回はここまで!


参考

YAHAGI Hajime の紹介

幸せを生み出すITを追求するクエステトラの一味です。 国産の BPM ソフト Questetra BPM Suite で日本・世界を幸せにしたい。
YAHAGI Hajime の投稿をすべて表示

あわせて読みたい
55.カイゼン Tips の前の記事 見積承認フローの改善奮闘 - ファイル名の自動生成 -
55.カイゼン Tips の次の記事 見積承認フローの改善奮闘 - 見積書PDFファイルをBoxに自動保存 -
YAHAGI Hajime の他の記事 見積承認フローの改善奮闘 – 安全なファイルの提出(自動工程の開発) –

アーカイブ

 RSS