singlefax
言語

SingleFax APIのバージョン管理と非推奨化

エージェントやバックエンドはこの方針を前提に利用できます。現在のREST APIは/api/v1です。現時点で提供終了の予定はありません。

バージョン管理

公開REST APIのバージョンはURLパスで示します：https://singlefax.com/api/v1/…と、api.singlefax.com上の同じパスです。OpenAPIは/openapi.jsonにあり、info.versionはパスのメジャーバージョン（現在1.0.0）と一致します。

後方互換性のある追加変更（任意項目、新しいエンドポイント、新しいエラーdata.code値）は、ヘッダーを付けずv1のまま提供します。項目の削除、型の変更、新たな必須認証などの互換性を損なう変更は/api/v2として公開します。v1のリクエストやレスポンスの形式を予告なく変更しません。

非推奨化と提供終了

v1の操作または項目を廃止する場合、その操作のレスポンスにはRFC 8594のDeprecation（廃止予定とした日）とRFC 8594のSunset（使用できなくなる日）を含めます。SunsetはDeprecationの少なくとも90日間後に設定します。OpenAPIでも同じ操作にdeprecated: trueを付けます。

現在、DeprecationまたはSunsetを付けたv1操作はありません。/mcpのMCP Streamable HTTPでも、ツールの削除には同じ通知期間を適用します。

機械から読み取るための情報源