アプリタイプとは
- アプリタイプは、freeeアプリの目的に関する分類です。
- freeeアプリはアプリタイプによって、適用されるAPIのポリシーが異なります。
- また、アプリタイプは一度選択すると後から変更することができません。
アプリタイプとポリシーの一覧
アプリタイプ | 利用事業所数の制限 | freeeアプリストアへの掲載 | 銀行明細の取得※2 | 金融サービスの提供 |
---|---|---|---|---|
プライベートアプリ 特定事業所のみでの利用を目的としたアプリ | あり 利用可能な事業所数は5以下までに制限されます。 ※1 | 不可 プライベートアプリは特定事業所での利用を目的としているため、アプリストアに掲載することはできません。 | 制限なし (申請不要) | ー |
パブリックアプリ 複数の事業所での利用(配布)を目的としたアプリ開発用テスト事業所では作成できない | あり デフォルトでは、利用可能な事業所数は20以下までに制限されます。 ※1ただし、アプリストアに公開、またはfreeeに申請すると、事業所数制限をクリアすることができます。 | 可能 freeeに申請いただき、審査の上問題がなければfreeeアプリストアへの掲載が可能です。アプリ審査については「審査について」をご確認ください。 | 申請が必要 申請内容を元にセキュリティチェックを行います。申請はfreee API 銀行明細取得申請フォームにて受け付けています。 | 申請が必要 申請内容を元にセキュリティチェックを行います。申請はfreeeアプリストア 金融サービス申請フォームにて受け付けています。 |
※1:freeeアプリストアで作成する開発用テスト事業所を除きます。
※2:GET /api/1/wallet_txnsまたはGET /api/1/wallet_txns/{id}に対するアクセスのうち、walletable_typeがbank_accountまたは指定なしのもの
利用事業所数の上限について
- freeeのアプリはアプリタイプによって、「利用可能な事業所数の上限」を設けています。
- プライベートアプリ:5事業所以下
- パブリックアプリ:20事業所以下(デフォルト)
- この上限は、開発者が広く一般提供するfreee アプリについて、セキュリティやfreeeのAPIポリシーに即して作成されているかを確認するために設けています。
利用事業所数の上限の変更方法
- パブリックアプリは、以下のいずれかの方法で利用事業所数の上限を変更することができます。
- 方法①freeeアプリストアに公開する(推奨)
- 作成したfreeeアプリをfreeeアプリストアに公開することで、利用可能な事業所数を20→無制限に変更することができます。
- freeeアプリストアにアプリを公開することで、より多くのfreeeユーザーにご自身のアプリを告知、利用いただくことができます。
- なお、アプリを公開するには審査が必要になります。詳しくはアプリケーションを公開すると、アプリ審査についてを確認してください。
- 方法②利用事業所数の上限変更の申請
- アプリの内容によっては「21事業所以上で利用はしたいが、freeeアプリストアでの一般公開には向かないアプリ」である場合が考えられます。
- 例:親会社が自身の複数のグループ会社の情報管理のために作成したアプリ
- 上記のようなアプリについては、「利用事業所情報タブ」から「利用事業所数の上限変更申請」を行うことで、利用可能な事業所数を20→無制限に変更することができます。
- なお、上限変更申請は利用事業所が15事業所に達するまで申請できません。
- 上限変更申請にあたって、アプリの審査が必要になります。詳しくはアプリ審査についてを確認してください。
- アプリの内容によっては「21事業所以上で利用はしたいが、freeeアプリストアでの一般公開には向かないアプリ」である場合が考えられます。
利用事業所数のカウント方法
- 利用事業所数は「アプリがアクセス可能な事業所数」(有効な連携事業所数)で計測します。
- 以下の資料でカウント方法を確認してください。
- ただし、freeeアプリストアで作成する「開発用テスト事業所」は事業所のカウントに含まれません。
- 利用事業所数のカウントの増加を防ぐ方法は複数あります。
- ①freeeがデフォルトで提供する認証用URLを利用する
- 利用事業所数の上限に迫っているアプリの多くは「&prompt=select_companyを外した認証用URL(旧認証URL)」を利用しています。
- 旧認証のURLを利用すると、「そのユーザーが所属する全ての事業所」にアクセスできる認可コード・アクセストークンが発行されてしまうため、必要以上に事業所のカウントが増えてしまう可能性があります。
- 「&prompt=select_companyがついたデフォルトの認証用URL」を利用すれば、ユーザーは単一の事業所のアクセスしか認可しない(事業所個別に認可コード・アクセストークンを発行できる)ので、事業所数の増加を抑えることができます。
- 認証用URLについて詳しくは事業所の選択についてを確認してください。
- ②必要最低限の事業所に所属するユーザーで認可をする
- 先述の通り複数の事業所に所属するユーザーが旧認証URLでアプリの認可を行うと、一度の認可で利用事業所が複数増えてしまいます。
- 必要最低限の事業所に所属するユーザーを作成し、そのユーザーで認可を行うことで利用事業所数の増加を限定することができます。
- ③ユーザーに「マイアプリ」から「連携解除」を選択させる
- 利用事業所数は、ユーザーがアプリ連携を解除をすることで減らすことができます。
- アプリの連携解除の方法
- アプリを利用するユーザーが、freeeにログインした状態で、マイアプリ一覧にアクセスします。
- 現在の事業所で利用しているアプリの一覧が表示されます。右下の「連携解除」を選択し、アプリの連携を解除することで、利用事業所数を減らすことができます。
- ※他のユーザーが同一事業所で、同一アプリを連携している場合は、利用事業所のカウントは減りません。全てのユーザーが連携解除をしてください。
- ④「開発用テスト事業所」を利用する
- 開発用テスト事業所は、アプリの事業所数のカウントに含まれません。
- 検証が目的のアプリ、複数の事業所での検証が必要なアプリであれば正規の事業所ではなく「開発用テスト事業所」に所属するユーザーでアプリを認可・検証することを推奨します。
- ①freeeがデフォルトで提供する認証用URLを利用する
利用事業所数の上限を変更するアプリの注意点
- 「方法①freeeアプリストアに公開する」・「方法②利用事業所数の上限変更の申請」いずれの方法に関わらず、利用可能な事業所数を無制限にするfreeeアプリは、権限を適切に管理する必要があります。(アクセス権限は必要最小限に設定する必要がある。)
- 一度アプリストアに公開、または上限を変更したアプリについては、再度権限を追加する場合は、再度アプリの審査が必要になります。
- アプリの審査後、アプリの権限追加を承認すると、全てのアクセストークンが一度破棄されます。権限追加後は、アプリを利用するユーザーに「アプリの再認可」を実施するよう連絡をしてください。