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를 표시합니다.
현재 v1 작업에는 Deprecation 또는 Sunset 헤더가 포함되어 있지 않습니다. /mcp의 MCP Streamable HTTP에서도 도구가 삭제되는 경우 같은 사전 안내 기간을 적용합니다.
프로그램에서 이 정보를 확인하는 위치
- 이 페이지: /versioning
- Markdown: /versioning.md
- OpenAPI: /openapi.json
- 에이전트 색인: /llms.txt
- 개발자 포털: /developers