はじめに
WorkatoでBoxとの接続はOAuth 2.0認証を利用しています。OAuth 2.0認証では、BoxがWorkatoに対してアクセストークンを発行します。Workatoは、そのアクセストークンを用いてBoxと接続します。
一度払い出されたBoxのアクセストークンの有効期限は60日のため、該当のコネクションを通じて60日間何もBoxアクションを利用しないと下記のようにコネクションがロストします。
Workatoのレシピを利用している業務によっては、60日以上利用されないことがあるかもしれません。
本記事では、そのようなケースで有効なBoxコネクションの有効期限切れの対策を紹介します。
Boxコネクションの有効期限切れの対策
対策は単純でアクセストークンの有効期限が切れる前にAPIをコールすることです。
BoxはOAuth 2.0認証を利用しており、1度でもAPIをコールすれば、アクセストークンが更新されるため、Boxコネクションの有効期限が延長されます。
わざわざレシピを作成して手動でアクセストークンを更新するのは手間であるため、スケジュールトリガーを用いて定期的にAPIを呼び出して、アクセストークン切れを回避するレシピを紹介します。
Boxコネクション有効期限切れ回避のレシピ
Boxには接続しているユーザー情報を取得するAPIが存在します。そのAPIを定期的に呼び出すようにすることで、Boxのデータに影響しないようにAPIを操作することができます。
レシピの構成としては、トリガーにスケジュールトリガーで毎月1日にレシピを実行するようにします。アクションは、Boxコネクションのカスタムアクションを用いて接続しているユーザー情報を取得するAPIを呼び出します。
サンプルレシピは参考リンクに記載しています。
まとめ
まとめると、以下のようになります。
- BoxのコネクションはOAuth 2.0認証を利用かつ、一定期間利用しないと接続がロストしてしまうため、アクセストークンの有効期限が切れる前にAPIをコールする必要があります。
おわりに
いかがでしょうか？ Boxのコネクションを定期的にコールするレシピを作成することでアクセストークンの有効期限を気にすることなくBoxコネクションを利用することができるようになります。
また、今回はBoxを対象としましたが、Boxに限らずOAuth 2.0認証を利用してコネクションを接続しているものには、この対策が有効的です。
Workatoの導入・導入後の活用などでお困りの場合、Workatoリセラーにご相談する方法もございます。お困りごとがございましたら、認定リセラーの日立ソリューションズへ是非ご相談ください。
参考リンク
- 株式会社 日立ソリューションズ
- Workato 公式サイト
- 本記事のサンプルレシピ
- Boxコネクション有効期限切れ回避
- JPデータセンター利用者向け
- USデータセンター利用者向け
- Boxコネクション有効期限切れ回避