EN English ES Español DE Deutsch FR Français PT Português JP 日本語 CN 中文 AR العربية IT Italiano KR 한국어 RU Русский NL Nederlands TR Türkçe PL Polski SE Svenska
Referência para desenvolvedores

Versionamento e descontinuações

A versão da API faz parte do caminho, por exemplo /v1/status . Dentro de uma versão, as requisições existentes continuam a funcionar.

Versionamento e descontinuações

A versão da API faz parte do caminho, por exemplo /v1/status. Dentro de uma versão, as requisições existentes continuam a funcionar. Esta página explica o que pode mudar, com que antecedência você é avisado e como encontrar as requisições que precisam ser atualizadas.

Mudanças sem aviso prévio

Novos endpoints, parâmetros opcionais, campos de resposta, valores em listas de opções existentes, cabeçalhos de resposta e códigos de erro podem ser adicionados a qualquer momento. Escreva clientes que ignorem os campos que não conhecem e tratem novos valores de forma adequada.

Mudanças incompatíveis

Remover ou renomear um endpoint, parâmetro ou campo, ou alterar o seu significado, só acontece após pelo menos 12 meses de aviso prévio. Durante esse período, a forma antiga continua a funcionar, as respostas às requisições que a usam trazem os cabeçalhos Deprecation e Sunset, e a mudança é registrada no changelog.

Nomenclatura das chaves de resposta

A maioria das chaves de resposta está em snake_case. Para receber todas as chaves em snake_case, adicione naming=snake ou envie o cabeçalho DomScan-Naming: snake. A adesão é opcional, portanto as respostas padrão não mudam. Consulte chaves snake_case.

Aliases descontinuados

Estes parâmetros mais antigos ainda funcionam. Cada um continua a funcionar pelo menos até a sua data de desativação. Migre para o substituto antes dessa data.

ParâmetroEndpointUse em vez dissoDescontinuado emDesativação
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 (Corpo JSON)POST /v1/status/bulkmax_age=25920002026-10-102027-10-10
prefer_cache (Corpo JSON)POST /v1/status/bulkmax_age=25920002026-10-102027-10-10
options.skip_cache (Corpo JSON)POST /v1/status/bulkmax_age=02026-10-102027-10-10
options.cache_skip (Corpo JSON)POST /v1/status/bulkmax_age=02026-10-102027-10-10
options.cache-skip (Corpo 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 (valor numérico)GET /v1/certificatescursor=<next_cursor>2026-10-102027-10-10
offsetGET /v1/email/blacklistcursor=<next_cursor>2026-10-102027-10-10

Detectar descontinuações

Uma requisição que usa um alias descontinuado recebe estes cabeçalhos de resposta. O corpo da resposta permanece igual.

  • Deprecation: a data em que o alias foi descontinuado, como @ seguido de segundos Unix (RFC 9745).
  • Sunset: a data mais próxima em que o alias pode deixar de funcionar (RFC 8594).
  • Link: um link para esta página com 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"

Os navegadores podem ler os três cabeçalhos. Registre-os em log ou crie um alerta para Deprecation para encontrar o código que precisa ser atualizado antes da data de desativação.

Toda descontinuação também é anunciada no changelog da API.