ベースURL、バージョン管理、エンドポイントの構成
Sorsa APIはURLにバージョンを含めることで、連携の安定性を維持しています。バージョン番号はベースURLの一部であり、すべてのリクエストは特定のAPIバージョンを明示的に指定します。ベースURL
すべてのリクエストはHTTPSで送信します。通常のHTTPには対応しておらず、リクエストは拒否されます。現在のバージョン：v3
v3 は、Sorsa APIの現在の安定版であり、推奨バージョンです。新しいエンドポイント、レスポンスフィールド、改善はすべてv3で提供されます。
変更のバージョン管理
すべての更新で新しいバージョン番号が必要になるわけではありません。変更は2種類に分かれます。後方互換性のある変更（v3内で提供）
以下の変更は、バージョン番号を上げずに現行バージョンに追加されます。既存の連携は、利用者側で変更することなく動作し続けます。- 新しいエンドポイントの追加
- 既存のエンドポイントへの任意のクエリパラメータの追加
- JSONレスポンスオブジェクトへの新しいフィールドの追加
- エラーメッセージの改善やエラーレスポンスへの詳細情報の追加
互換性を損なう変更（新しいバージョン番号）
レスポンスフィールドの削除、パラメータ名の変更、認証方式の変更、エンドポイントの基本動作の変更が必要になった場合は、新しいバージョン（例えば/v4）を公開します。その際は、次の対応を行います。
- 終了までの移行期間を明確に案内し、その間は旧バージョンを稼働させます
- フィールドの対応関係と構造上の変更を記載した移行ガイドを事前に公開します
- 廃止までの日程をダッシュボードとドキュメントで案内します
旧バージョン：v2（提供終了）
v2は廃止され、すでに停止しています。予定されていた停止日は2026年5月1日で、現在v2のエンドポイントは410 Gone を返します。
既存のSorsa v2連携を移行する場合は、現在のAPIリファレンスでv3のリクエストとレスポンスのスキーマを確認し、移行支援が必要ならサポートにお問い合わせください。別途用意されている公式X APIからの移行ガイドは、Sorsa v2とは異なるAPIを対象としています。