> For the complete documentation index see https://domscan.net/llms.txt. Markdown versions of every docs page are available by appending .md to the page URL.

Source: https://domscan.net/pt/docs/versioning

# 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.

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](https://domscan.net/pt/docs/response-format#naming).

### 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âmetro | Endpoint | Use em vez disso | Descontinuado em | Desativação |
| --- | --- | --- | --- | --- |
| `prefer_cache` | `GET /v1/status` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/status` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `cache_skip` | `GET /v1/status` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `cache-skip` | `GET /v1/status` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `options.prefer_cache` (Corpo JSON) | `POST /v1/status/bulk` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `prefer_cache` (Corpo JSON) | `POST /v1/status/bulk` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `options.skip_cache` (Corpo JSON) | `POST /v1/status/bulk` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `options.cache_skip` (Corpo JSON) | `POST /v1/status/bulk` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `options.cache-skip` (Corpo JSON) | `POST /v1/status/bulk` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `prefer_cache` | `GET /v1/subdomains` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/tech` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/categorize` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/identity-assets` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/identity-resolution` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/url-intelligence` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/agent-readiness` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/robots` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `refresh` | `GET /v1/ssl/deep-scan` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `cursor` (valor numérico) | `GET /v1/certificates` | `cursor=<next_cursor>` | 2026-10-10 | 2027-10-10 |
| `offset` | `GET /v1/email/blacklist` | `cursor=<next_cursor>` | 2026-10-10 | 2027-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"`.

```bash
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](https://domscan.net/pt/changelog).