メインコンテンツへスキップ
Automation API は セマンティックバージョニング を使用します。

​
API 全体のバージョニングについて

破壊的変更は、以下の例外を除き、新しいメジャー API バージョンでのみ発生します。
  • まだ使用されていないエンドポイントは、マイナーバージョン (1.x) で破壊的変更を含むことがあります。
  • 下位互換性を損なう重大なセキュリティ修正はマイナーバージョンでリリースされる場合があります。すべての API 変更は changelog で確認してください。
破壊的変更には、次のタイプの変更が含まれます。
  • オペレーション全体の削除。
  • パラメーターの削除または名前変更。
  • レスポンスフィールドの削除または名前変更。
  • 新しい必須パラメーターの追加。
  • これまで任意であったパラメーターを必須にすること。
  • パラメーターまたはレスポンスフィールドの型変更。
  • 列挙値の削除。
  • 既存パラメーターへの新しい検証ルールの追加。
  • 認証または認可要件の変更。
加算的(非破壊的)変更は、サポートされているすべての API バージョンで利用できます。加算的変更とは、統合を壊さない変更を意味します。加算的変更には次のものが含まれます。
  • オペレーションの追加。
  • 任意パラメーターの追加。
  • 任意のリクエストヘッダーの追加。
  • レスポンスフィールドの追加。
  • レスポンスヘッダーの追加。
  • 列挙値の追加。
Kameleoon が新しいメジャー API バージョンをリリースする場合、以前のバージョンは少なくとも 3 か月間サポートされます。

​
API バージョンの指定

デフォルトでは、https://api.kameleoon.com は最新の API バージョンを使用します。バージョンを指定するには、URL にバージョンを含めます (たとえば、https://api.kameleoon.com/v1/)。次のメジャーバージョンがリリースされると、https://api.kameleoon.com/v2 で利用可能になります。

​
API のエンドポイントごとのバージョニングについて

一部のエンドポイントはバージョン指定をサポートしています。たとえば、特定のエンドポイントの新しいバージョンが、デフォルトの API バージョンよりも優先されることがあります。利用可能な場合は、version パラメーターを使用して、目的のエンドポイントバージョンを指定します。 新しいメジャーバージョンがリリースされると、以前のバージョンはすべて削除されます。たとえば、エンドポイントが 1.0.0 API バージョンでバージョン 1 およびバージョン 2 を持つ場合、2.0.0 API バージョンには、そのエンドポイントの最新バージョンのみが含まれます。