メインコンテンツへスキップ

バージョニング

Flex Forward APIは長期的な安定性を重視して設計されています。既存のインテグレーションに影響を与えないよう、変更は慎重に行われます。

現在のバージョン

APIのバージョンは 1.0.0 です。URLにバージョンプレフィックスはありません。すべてのエンドポイントは直接アクセスします(例:POST /labelsPOST /v1/labels ではありません)。

後方互換性

Flex Forwardチームは後方互換性の維持に取り組んでいます。既存のインテグレーションはAPIの進化とともに引き続き機能します。

非破壊的変更

以下の変更は事前通知なしに行われる場合があります。インテグレーションはこれらを適切に処理する必要があります:
  • リクエストボディへの新しいオプションフィールドの追加
  • レスポンスボディへの新しいフィールドの追加
  • 新しいAPIエンドポイントの追加
  • レスポンスフィールドの新しいenum値の追加
  • エッジケース用の新しいHTTPステータスコードの追加
  • エラーメッセージの明確化
APIレスポンスで予期しないフィールドをエラーとして扱うのではなく、無視するようにしてください。未知のenum値も適切に処理してください — 例えば、認識できない追跡 tagUnknown として扱います。これにより、非破壊的な追加に対するインテグレーションの耐性が確保されます。

破壊的変更

以下の変更は破壊的と見なされ、事前に通知されます:
  • 既存フィールドの削除または名前変更
  • 既存フィールドのデータ型の変更
  • APIエンドポイントの削除
  • 認証メカニズムの変更
  • 既存ステータスコードの意味の変更
破壊的変更は変更履歴および影響を受けるAPIコンシューマへの直接通知を通じて事前にお知らせします。非破壊的な改善は、既存のインテグレーションの後方互換性を維持しつつ、URLバージョンの変更なしにリリースされる場合があります。

インテグレーションの推奨事項

  • レスポンスボディを寛容に解析する — 不明なフィールドを無視する
  • 新しいフィールドを拒否する厳密なスキーマに対してレスポンスをバリデーションしない
  • APIの変更に関する更新については変更履歴を参照する
  • インテグレーションの更新時は開発環境でテストする