freee Public APIで共通の仕様、項目をまとめています。
- プロダクト共通
- APIエンドポイント
- 認証と認可、アクセストークン
- データフォーマット
- 後方性互換有の変更
- エラーハンドリング
- プロダクト別のAPI概要と仕様
APIエンドポイント
https://api.freee.co.jp/
- httpsのみ有効
会計や人事労務など、プロダクトによってpathが異なります。詳細は各プロダクトのAPIリファレンスを参照してください。
認証
OAuth
2.0を使用します。この仕組みにより、アプリケーション利用者はfreeeのIDとパスワードをアプリケーションに教えることなくログイン、アプリケーションを利用することができます。
認証認可におけるAPIからのエラーレスポンスについて
freeeではRFCに準拠してOAuth2.0の実装をしています。以下の資料のケースに応じた”エラーレスポンス”の項を参照してください。
データフォーマット
リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細はAPIリファレンス内のContent-type(application/jsonなど)を確認してください。一部multipart/form-dataのみに対応しているエンドポイントがあります。
リクエスト時はリクエストヘッダーに以下のようにContent-Typeを正しく入れてください
Content-Type: application/json
後方互換性ありの変更
freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。
- 新しいAPIリソース・エンドポイントの追加
- 既存のAPIに対して必須ではない新しいリクエストパラメータの追加
- 既存のAPIレスポンスに対する新しいプロパティの追加
- 既存のAPIレスポンスに対するプロパティの順番の入れ変え
- keyとなっているidやcodeの長さの変更（長くする）
- エラーメッセージの変更
エラーハンドリング
各プロダクトのAPIリファレンスを参照してください。
会計APIの場合、以下も併せて参照してください。