ケンオールAPIでは、APIリクエスト/レスポンス定義のAPIバージョンの違いを指定する「APIバージョニング」方式を採用しています。
APIバージョニングの詳細については、次のURLをご参照ください。
このたび、ご提供するAPIバージョンを見直すこととなりましたので、お知らせいたします。
以前こちらのブログの記事でアナウンスさせていただいた際には、以下の主旨のご説明をしておりました。
- 互換性維持のため、全既存ユーザーの作成済みAPIキーのデフォルトバージョンに
2022-09-01を設定した。 - 新規に作成したAPIキーはデフォルトでバージョンが
指定なしとなり、最新バージョンが設定される。
今回影響を受けるお客様は以下となります。
- APIキーのデフォルトバージョンが
指定なしとなっている。 - APIキーのデフォルトバージョンが
2022-09-01となっているか、もしくは、ケンオールAPIのご利用時に明示的にバージョン2022-09-01を指定している。
a. APIキーのデフォルトバージョンが 指定なし となっているお客様向けのご対応のお願い
APIバージョンが 指定なし である場合の実効バージョンは、その時点での最新のバージョンである旨をアナウンスしておりましたが、お客様への影響を考慮し、実際には 2023-09-01 が実効バージョンとなっておりました。
2025年5月30日 00:00 (日本時間) をもちまして、APIバージョンが 指定なし である場合の実効バージョンを、2025-01-01 に変更いたします。この変更は、複数バージョンを維持することが困難となってきており、サービスの安定性の向上を目標としております。
当該バージョンの変更点につきましては別記いたしますが、API バージョン 2025-01-01 をご利用になる際、ケンオールJavaScript SDKをご利用の場合は、アップデートが必要となります。誠にお手数ですが、最新の v2.0.1 にアップデートをお願いいたします。
SDKのアップデートが困難などの状況の際は、デフォルトのAPIバージョンを 指定なし から 2022-11-01 以降のバージョンに変更してご利用をお願いいたします。
b. APIキーのデフォルトバージョンが 2022-09-01 となっているか、もしくは、ケンオールAPIのご利用時に明示的にバージョン 2022-09-01 を指定しているお客様向けのご対応のお願い
APIバージョン 2022-09-01 につきましては、2024年12月31日をもちまして廃止とさせていただいておりました。2025年10月1日 00:00 (日本時間) をもちまして、完全にご利用いただけない状態となりますのでご注意ください。具体的には、以下の措置を実施いたします。
- 2025年10月1日をもちまして、デフォルトバージョンに
2022-09-01を指定しているAPIキーは、すべてデフォルトバージョンが2022-11-01となるように強制的に変更されます。 - 2025年10月1日以降に、APIバージョン
2022-09-01を指定するAPIリクエストは、 APIバージョン2022-11-01を指定するものとして処理します。
この時点で対応が難しいお客様につきましては、延長サポートを個別にご提供いたしますので、ケンオールサポート宛にご連絡いただければと存じます。
APIバージョン変更点のサマリー
| 〜2025年5月29日 23:59:59 | 2025年5月30日 00:00:00 | 2025年9月30日 23:59:59 | 2025年10月1日 00:00:00 | |
|---|---|---|---|---|
| デフォルトのAPIバージョン | 2023-09-01 |
2025-01-01 |
2025-01-01 |
2025-01-01 |
| ご利用いただけるAPIバージョン |
|
|
|
|
バージョン 2025-01-01 における変更点
- 法人番号APIの法人情報のレスポンスにおいて、
close_causeの型がstringからnumberに変更になりました。これは、2024-01-01でprocesscorrectkindhihyojiについて同様の変更を実施していたのですが、close_causeについての対応が漏れていたことによるものです。 - 銀行情報APIの支店番号に対応する「支店」のレスポンスについて、これまで単一の支店情報のみを返していたところを、複数の情報を返すよう変更しました。これは、ある支店番号について複数の支店が対応するケースに対応するものです。
最後に
ご不明な点は、ケンオールサポートまでお問い合わせください。
