いつもfreee APIをご利用いただき誠にありがとうございます
freee APIをお使いのユーザー様に影響のある内容ですので、必ず内容をご確認いただき、必要なご対応をお願いいたします。
ご不明な点がございましたらdev-support@freee.co.jpまでご連絡ください。
取引先API GET
================================================
■ 仕様変更内容
(1)取引先API GET時に返すlimitに制限を入れます。
| 現在 | 変更後 |
| デフォルト値 = 無し | デフォルト値 = 50、最大値 = 500 |
(2)keywordをパラメータとして追加します。
■ 仕様変更理由
1事業所辺りの取引先件数が多くなる過程での安定した稼働、
またkeyword検索による利便性向上のため。
■ 影響範囲
取引先APIでGETメソッドをご利用のユーザー様
■ 必要なご対応
GETリクエストにlimit,offsetを活用したループ処理の実装をお願いします
■ 新仕様リリース予定日
2018年10月1日(月)
================================================
認証基盤のアップデート
================================================
■ 仕様変更内容
認証に利用しているライブラリのアップデートを行います。
アップデートに伴いパラメータの返し方、およびエラー文が変更になります。
詳細は下記をご参照ください。
■ 仕様変更理由
セキュリティ強化のため
■ 影響範囲
freee APIご利用のユーザー様
■ 新仕様リリース予定日
2018年9月18日(火)-19日(水)
================================================
クライアント認証失敗時のエラーメッセージ変更
client_id / client_secret によるクライアント認証に失敗した場合のエラーメッセージが下記のように変わります。
| 現在 | 変更後 |
| 「クライアント認証は次のいずれかの理由で失敗しました。不明なクライアント、クライアント認証が含まれていない、サポートされない認証メソッド」 | 「クライアントが不明か、クライアント認証が含まれていないか、もしくは認証メソッドがサポートされていないため、クライアント認証は失敗しました。」 |
Authorization code の許可・拒否における挙動の変更
「Web認証用URL」にアクセスし、アプリケーションによるリソースアクセスの許可・拒否を行なった場合の挙動に変更があります。
redirect_uri がテスト用（urn:ietf:wg:oauth:2.0:oob）の場合
リダイレクトされるURLが次のように変わります。 拒否時のjsonで返すエラーメッセージが次のように変わります。 |
||
| 現在 | 変更後 | |
| 許可時 | https://secure.freee.co.jp/oauth/authorize/authorization_code | https://secure.freee.co.jp/oauth/authorize/native?code=authorization_code |
| 拒否時 | {“error”:”access_denied”,”error_description”:”リソース保有者もしくは認証サーバはリクエストを拒否しました。”} | {“error”:”access_denied”,”error_description”:”リソースオーナーもしくは認可サーバがリクエストを拒否しました。”} |
| redirect_uri が有効なURL形式の場合 | ||
| 拒否時 | &error_description=${error_description} リソース保有者もしくは認証サーバはリクエストを拒否しました。 |
&error_description=${error_description} リソースオーナーもしくは認可サーバがリクエストを拒否しました。 |
※authorization_code はaccess token 取得時に code パラメータに渡す値です。
Implicitの許可・拒否における挙動の変更
redirect_uri がテスト用（urn:ietf:wg:oauth:2.0:oob）の場合
- 許可時
- 拒否時
リダイレクトされるURL、レスポンスの形式、メッセージの内容が次のように変わります。
テスト用途では特に問題ありません。
メッセージの値が次のように変わります。
| 許可時 | ||
| 現在 | 変更後 | |
| リダイレクトされるURL | https://secure.freee.co.jp/oauth/authorize/access_token | https://secure.freee.co.jp/oauth/token/info?access_token=access_token |
| レスポンス形式 | HTML | JSON |
| メッセージの内容 | HTMLの中に access token の値を表示 | {“resource_owner_id”:resource ownerであるuser_idの値,”scopes”:[“read”,”write”],”expires_in_seconds”:86399,”application”:{“uid”:”client_idの値”},”created_at”:unixtime stampの値} |
| 拒否時 | ||
| メッセージの内容 | {“error”:”access_denied”,”error_description”:”リソース保有者もしくは認証サーバはリクエストを拒否しました。”} | {“error”:”access_denied”,”error_description”:”リソースオーナーもしくは認可サーバがリクエストを拒否しました。”} |
redirect_uri が有効なURL形式の場合
クエリパラメータerror_descriptionに渡されるURLエンコードされた値が次のように変わります。
| 拒否時 | ||
| 現在 | 変更後 | |
| メッセージの内容 | {“error”:”access_denied”,”error_description”:”リソース保有者もしくは認証サーバはリクエストを拒否しました。”} | {“error”:”access_denied”,”error_description”:”リソースオーナーもしくは認可サーバがリクエストを拒否しました。”} |