会計freee Firebase SDK

freee アプリストアのアプリを Firebase 上で開発するための SDK です。

できること

• freee ログイン -> 認可 -> リダイレクト -> Firebase にアカウント情報保存 -> Firebase ログインの一連の処理
• freee の API をトークンを意識せず呼び出すことが可能
• freee アクセストークン・リフレッシュトークンの暗号化・復号処理

このSDKについて

本 SDK は主要な機能が含まれていますが、β版のステータスとなっており、制限およびバグがある可能性があります。また、このステータスの記載が更新されるまでは、API やインターフェイスに変更が入る可能性がありますので、ご利用の際はご留意ください。

バージョン

【重要】会計freee APIの新バージョンについて

2020年12月まで、2つのバージョンが利用できる状態です。古いものは2020年12月に利用不可となります。

会計freee APIの最新バージョン2020-06-15を利用するにはSDKのバージョンv2.0.1を、古いAPIバージョン2019-01-31を利用するにはSDKのバージョンv1.0.1を利用して下さい。v1.0.1を利用する場合は2020年12月に廃止予定のAPIを利用することとなります。会計freee APIのバージョンについて詳細は こちら をご覧ください。

目次

• チュートリアル
  • 前提条件
  • freee アプリストアへのアプリケーション登録
  • サンプルアプリ
  • SDK の導入方法
• ライセンス

チュートリアル

本 SDK を利用する手順について記載します。

前提条件

本 SDK を利用する前に下記をご確認ください。

• freee 本体のアカウントを持っていること
• Firebase のアカウントを持っていること

freee 本体のアカウントは、後述する freee アプリストアへのアプリケーション登録 で必要になります。

freee API に関しては、チュートリアルガイド をご参照ください。

Firebase の基礎知識については、Google が提供するFirebase のドキュメント をご参照ください。

freee アプリストアへのアプリケーション登録

本 SDK で利用する ClientId および ClientSecret を取得するため、freee アプリストアの開発者ページでアプリケーションを登録します。

こちらの チュートリアル | freee アプリストア を参考に、アプリケーションを登録して下さい。

サンプルアプリ

WebApp のサンプル

こちらのサンプルアプリのリポジトリの README にしたがって、セットアップを行なってください。

SDK の導入方法

該当のプロジェクトディレクトリで以下のコマンドを実行してください。

npm install freee-firebase-sdk

ライセンス

ライセンスについては下記をご参照ください。

MIT License