バージョン管理のスケジュール

Bookings Insight API の進化し続けるスキーマおよびバージョン管理戦略の詳細についてご紹介します。

進化するスキーマ

目まぐるしく変化するテクノロジーの世界では、常に一歩先を行くことが重要です。そのため、当社の Analytics API は皆様のニーズに追いつけるように設計されています。進化し続けるスキーマにより、新機能は開発された瞬間に提供されます。新しいリリースまで長期間待たされる状況や面倒なアップグレードプロセスに別れを告げましょう。

当社の最新機能はシームレスに統合されるように設計されているため、中断することなく現行バージョンを継続してご利用いただけます。このアプローチによって時間とコストの両方が節約されます。今後予定されている機能については随時お知らせするため、効果的な計画を立てることができます。

バージョン管理戦略

既存の統合に影響を与える可能性のある重要な更新や変更については、Analytics API v2 のような新しいバージョンを導入します。

当社の API チームでは、アクティブバージョンを管理しながら、次のバージョンを開発しています。新バージョンがリリースされるとそれがアクティブバージョンとなり、前のバージョンは非推奨フェーズに入ります。非推奨バージョンになったあとも 1 年間は利用できるため、移行まで十分な時間を取ることができます。この期間中、非推奨バージョンには重要なセキュリティ更新のみが行われます。

用語集

当社のバージョン管理スケジュールが理解しやすくなる用語をご紹介します。

アクティブ : Analytics API の最新バージョンで、微細な変更や機能が追加されています。これらの機能を自由に統合することができます。

開発 : 開発中の API の次期バージョン。

非推奨 : 非推奨に指定されたバージョンは 1 年後に廃止されます。この期間中に最新のアクティブバージョンにアップグレードすることをおすすめします。

提供終了 : 提供を終了したバージョンは API からアクセスできなくなります。

微細な変更 : 既存の設定に影響を与えることなく統合できるアップデートです。新しいエンドポイント、必須ではないクエリパラメーター、レスポンスフィールドなどが追加されています。

微細な変更には次のものがあります。

新しいエンドポイントの追加
新しいオプションのクエリパラメータの追加
リクエスト本文への新しいオプションのリクエストフィールドの追加
リクエストへの新しいオプションのヘッダーの追加
リクエストパラメータの必須からオプションへの変更
レスポンスへの新しいフィールドの追加
レスポンスへの新しいヘッダーの追加
リクエスト列挙型への新しい値の追加
デフォルトがあるレスポンス列挙型への新しい値の追加

重大な変更 : 統合の変更が必要になる可能性がある重大なアップデートです。これには、エンドポイントの削除、新しい必須パラメーターの導入、認証設定の変更などが含まれます。重大な変更は API の新しいアクティブバージョンでのみ導入されます。

重大な変更には次のものがあります。

既存のエンドポイントの削除
新しいオプションのクエリパラメータの追加
リクエスト本文への新しい必須リクエストフィールドの追加
リクエストへの新しい必須ヘッダーの追加
オプションのリクエストパラメータの必須化
クエリパラメータの削除または名前変更
レスポンスフィールドの削除または名前変更
クエリパラメータのタイプの変更
リクエスト本文のリクエストフィールドのタイプの変更
既存のパラメータへの新しい検証要件の追加
認証または承認構成の削除または排除
列挙型値の削除または名前変更
デフォルトがないレスポンス列挙型への新しい値の追加