freeeのユーザーは1アカウントで複数の事業所を管理できます。アプリ連携時に、ユーザーがアクセスを許可する事業所を選択することを「事業所の選択」と呼びます。
※事業所とアカウントの関係について1
事業所選択の実装方法
推奨方法：デフォルトの認証用URL（&prompt=select_company）を使用
- freeeが提供する事業所選択機能が利用可能になります
- アプリは選択された1つの事業所にのみアクセス可能になります
- 開発者による事業所選択機能の実装は不要です
動作の流れ
- ユーザーが複数事業所に所属：事業所選択画面 → 認可画面
- ユーザーが単一事業所のみに所属：直接認可画面へ
デフォルトの認証用URL使用時の詳細仕様
トークン処理と事業所アクセス
- 認可後のtokenレスポンスにcompany_idが含まれる
- 事業所を指定するAPIを使用する場合
- 返却されたcompany_idの指定が必須
- company_idをトークンと共に保存が必要
アプリからのアクセス可能範囲
- 事業所選択に関係なくアクセス可能な情報
- ユーザー情報
- 所属している事業所名
- 権限情報
- 選択した事業所でのみアクセス可能な情報
- 事業所の詳細情報
- 事業所の詳細情報(アプリストアでアプリ開発者が設定したリソース)は選択した事業所でのみアクセスが可能
非推奨方法：&prompt=select_companyを外した認証用URLを使用
- アカウント内の全事業所へのアクセスが可能になります
- 開発者自身による事業所選択機能の実装が必要があります
- ストア審査時に”事業所選択”について考慮がされているかを確認します（考慮がされていない場合はアプリの公開を承認できません）
- 将来的に本方式は廃止予定になります
| 項目 | デフォルトの認証用URLを 利用する場合 | &prompt=select_companyを外した認証用URLを 利用する場合（非推奨） |
|---|---|---|
| ユーザーがアプリ利用開始時に行う操作 | アプリ連携を認可したい、アカウント内の一つの事業所を選択する。 | アカウント内の全ての事業所に対するアクセスを認可する。 |
| 適切なユースケース | アプリがアカウント内の単一の事業所にのみアクセスができれば良い場合。 | アプリがアカウント内の複数事業所にアクセスをする必要がある場合。 例）アドバイザーが顧問先の管理に使うレポーティング系アプリで、1度のログインで事業所を切り替えながらデータを参照する。 |
| 注意点 | アプリはユーザーが許可した一つの事業所にのみアクセスをすることができます。 | freeeアプリストアにアプリを公開する場合は、審査時に事業所選択が考慮されているか確認し、考慮されていない場合はアプリの公開を承認できません。 |
使用が必要となると考えられるケース
- 1度のログインで複数事業所へのアクセスが必要な場合
- 例：アドバイザーが複数の顧問先データを参照するレポーティングアプリ
