仕様変更について

APIの変更による後方互換性について

同一バージョン内のAPIにおいて、変更を行うことがあります。

  • 新しいAPIエンドポイントを追加
  • 新たに必須項目でない(Optionalな)リクエストパラメータを追加
  • レスポンスに、新しいパラメータを追加
  • レスポンスパラメータに新しい値(ステータス、タイプなどの値)を追加
  • レスポンスのオブジェクト、パラメータの順序を変更

これらは後方互換性を確保した変更として、予告無く追加されることがあります。
こうした変更に影響を受けない実装をおこなってください。

また、以下の変更は後方互換性を満たさない更新であり、同一バージョンのAPIにおいて、変更することはありません。

  • 既存のAPIエンドポイントの削除、および接続URLの変更
  • 既存のリクエストパラメータの削除、および名称などの変更
  • 既存のレスポンスオブジェクト、および、その各種パラメータの削除、および名称などの変更
  • 既存のレスポンスオブジェクト内の、各種パラメータの値の削除、および名称などの変更
  • 既存のレスポンスオブジェクト内の、「NULL不可」のパラメータを「NULL可」に変更
  • レスポンスオブジェクトの階層の変更(パラメータの階層の追加、削除、および変更)