개발자 참고자료

버전 관리와 지원 중단

API 버전은 경로에 포함됩니다. 예를 들어 /v1/status 입니다. 같은 버전 안에서는 기존 요청이 계속 작동합니다.

버전 관리와 지원 중단

API 버전은 경로에 포함됩니다. 예를 들어 /v1/status입니다. 같은 버전 안에서는 기존 요청이 계속 작동합니다. 이 페이지에서는 무엇이 변경될 수 있는지, 얼마나 사전에 안내받는지, 업데이트가 필요한 요청을 어떻게 찾는지 설명합니다.

사전 안내 없는 변경

새 엔드포인트, 선택적 매개변수, 응답 필드, 기존 옵션 목록의 새 값, 응답 헤더, 오류 코드는 언제든 추가될 수 있습니다. 클라이언트는 알 수 없는 필드를 무시하고 새로운 값을 유연하게 처리하도록 작성하세요.

호환성을 깨는 변경

엔드포인트, 매개변수, 필드를 제거하거나 이름을 바꾸거나 의미를 변경하는 작업은 최소 12개월 전에 안내한 후에만 이루어집니다. 그 기간 동안 이전 형식은 계속 작동하고, 이를 사용하는 요청의 응답에는 Deprecation 및 Sunset 헤더가 포함되며, 해당 변경은 변경 로그에 기록됩니다.

응답 키 명명

대부분의 응답 키는 snake_case입니다. 모든 키를 snake_case로 받으려면 naming=snake를 추가하거나 DomScan-Naming: snake 헤더를 보내세요. 옵트인 방식이므로 기본 응답은 변경되지 않습니다. snake_case 키를 참고하세요.

지원 중단된 별칭

다음 이전 매개변수는 아직 작동합니다. 각 매개변수는 최소한 종료일까지 계속 작동합니다. 그 전에 대체 항목으로 전환하세요.

매개변수엔드포인트대신 사용지원 중단일종료일
prefer_cacheGET /v1/statusmax_age=25920002026-10-102027-10-10
skip_cacheGET /v1/statusmax_age=02026-10-102027-10-10
cache_skipGET /v1/statusmax_age=02026-10-102027-10-10
cache-skipGET /v1/statusmax_age=02026-10-102027-10-10
options.prefer_cache (JSON 본문)POST /v1/status/bulkmax_age=25920002026-10-102027-10-10
prefer_cache (JSON 본문)POST /v1/status/bulkmax_age=25920002026-10-102027-10-10
options.skip_cache (JSON 본문)POST /v1/status/bulkmax_age=02026-10-102027-10-10
options.cache_skip (JSON 본문)POST /v1/status/bulkmax_age=02026-10-102027-10-10
options.cache-skip (JSON 본문)POST /v1/status/bulkmax_age=02026-10-102027-10-10
prefer_cacheGET /v1/subdomainsmax_age=25920002026-10-102027-10-10
skip_cacheGET /v1/techmax_age=02026-10-102027-10-10
skip_cacheGET /v1/categorizemax_age=02026-10-102027-10-10
skip_cacheGET /v1/identity-assetsmax_age=02026-10-102027-10-10
skip_cacheGET /v1/identity-resolutionmax_age=02026-10-102027-10-10
skip_cacheGET /v1/url-intelligencemax_age=02026-10-102027-10-10
skip_cacheGET /v1/agent-readinessmax_age=02026-10-102027-10-10
skip_cacheGET /v1/robotsmax_age=02026-10-102027-10-10
refreshGET /v1/ssl/deep-scanmax_age=02026-10-102027-10-10
cursor (숫자 값)GET /v1/certificatescursor=<next_cursor>2026-10-102027-10-10
offsetGET /v1/email/blacklistcursor=<next_cursor>2026-10-102027-10-10

지원 중단 감지

지원 중단된 별칭을 사용하는 요청은 다음 응답 헤더를 받습니다. 응답 본문은 동일하게 유지됩니다.

  • Deprecation: 별칭이 지원 중단된 날짜로, @ 뒤에 Unix 초를 붙인 형식입니다 (RFC 9745).
  • Sunset: 별칭이 작동을 멈출 수 있는 가장 이른 날짜입니다 (RFC 8594).
  • Link: rel="deprecation"이 포함된 이 페이지로의 링크입니다.
curl -i -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/status?name=example&tlds=com&skip_cache=true"

Deprecation: @1791590400
Sunset: Sun, 10 Oct 2027 00:00:00 GMT
Link: <https://domscan.net/docs/versioning#deprecated-aliases>; rel="deprecation"; type="text/html"

브라우저는 세 헤더를 모두 읽을 수 있습니다. 종료일 전에 업데이트가 필요한 코드를 찾으려면 Deprecation을 로그로 남기거나 알림을 설정하세요.

모든 지원 중단은 API 변경 로그에도 공지됩니다.