시작하기
버전 관리와 지원 중단
메이저 URL 버전, 호환되는 추가 사항, 지원 중단 공지, 종료 기간을 이해하세요.
안정적인 메이저 경로
고객 연동은 URL에 메이저 버전(현재 /api/v1)을 사용합니다. 날짜 기반 OpenAPI info.version은 해당 메이저 안에서 게시된 정확한 계약을 식별합니다.
호환되는 변경
SendHQ는 v1 안에서 선택적 요청 필드, 응답 필드, 스키마가 허용하는 경우의 enum 값, 새 작업을 추가할 수 있습니다. 클라이언트는 알 수 없는 응답 필드를 무시해야 하며, 스키마에 명시되어 있지 않은 한 enum을 영구적으로 닫힌 집합으로 취급해서는 안 됩니다.
호환되지 않는 변경
요청, 응답, 인증 또는 동작에 호환되지 않는 변경이 생기면 /api/v2 같은 새 메이저 경로, 마이그레이션 문서, 공지된 전환 절차가 필요합니다. 현재 v1 API는 지원 중단되지 않았습니다.
지원 중단과 종료
버전이 지원 중단되면 SendHQ는 대체 버전과 마이그레이션 경로를 문서화하고, 해당하는 경우 Deprecation 및 Sunset 헤더를 반환합니다. 지원 중단된 버전은 계속 운영하면 긴급한 보안 또는 법적 위험이 생기는 경우가 아닌 한, 게시된 지원 중단 날짜로부터 최소 90일 동안 계속 사용할 수 있습니다.