全自動クラウド会計ソフトfreeeの開発者向けAPIのドキュメントです。
本APIを利用することで、あなたのアプリやサービスをfreeeと連携させることができます。
- ユーザ情報の取得
- 事業所情報の取得
- 取引(収入・支出・振替)の照会/登録
- 口座明細の照会/登録
- 取引先の照会/登録
- 品目の照会/登録
- 勘定科目の照会
- 税区分の照会
- 口座情報の照会
https://api.freee.co.jp/ (httpsのみ)
OAuth2に対応
- Authorization Code Flow (Webアプリ向け)
- Implicit Flow (Mobileアプリ向け)
https://secure.freee.co.jp/ (httpsのみ)
- authorize : /oauth/authorize
- token : /oauth/token
リクエスト、レスポンスともにJSON形式をサポート
- freeeにサインアップします。
- アプリケーション一覧から「新しいアプリケーションを登録」します。
- アプリケーションの登録が完了すると、AppIDとSecretが取得できます。
- ローカルの開発環境でテストする際は、認証用URLを直打ちしてAuthorization Codeを取得できます。
https://secure.freee.co.jp/developers/api/doc
Authorization Code Flowでユーザ情報、事業所情報を取得するまでの実装例です。
- 使用する外部ライブラリ
- oauth2
- faraday
- faraday_middleware
-
本機能は現在β版として運用しており、予告なく新規APIが追加されることがありますのでご了承ください。
-
APIのパラメータ等が変更になる場合は、バージョンを更新して提供いたします。
ご不明点、ご要望等は以下までご連絡ください。