Versionado y obsolescencias
La versión de la API forma parte de la ruta, por ejemplo /v1/status . Dentro de una versión, las solicitudes existentes siguen funcionando.
Versionado y obsolescencias
La versión de la API forma parte de la ruta, por ejemplo /v1/status. Dentro de una versión, las solicitudes existentes siguen funcionando. Esta página explica qué puede cambiar, con cuánta antelación se avisa y cómo localizar las solicitudes que necesitan actualizarse.
Cambios sin previo aviso
Se pueden añadir en cualquier momento nuevos endpoints, parámetros opcionales, campos de respuesta, valores en listas de opciones existentes, cabeceras de respuesta y códigos de error. Escribe clientes que ignoren los campos que no conocen y que gestionen con elegancia los valores nuevos.
Cambios incompatibles
Eliminar o renombrar un endpoint, parámetro o campo, o cambiar su significado, solo ocurre tras un preaviso de al menos 12 meses. Durante ese tiempo la forma antigua sigue funcionando, las respuestas a las solicitudes que la usan incluyen las cabeceras Deprecation y Sunset, y el cambio se registra en el registro de cambios.
Nomenclatura de las claves de respuesta
La mayoría de las claves de respuesta están en snake_case. Para recibir todas las claves en snake_case, añade naming=snake o envía la cabecera DomScan-Naming: snake. Es opcional, por lo que las respuestas predeterminadas no cambian. Consulta claves snake_case.
Alias obsoletos
Estos parámetros antiguos siguen funcionando. Cada uno seguirá funcionando al menos hasta su fecha de retirada. Pasa al reemplazo antes de esa fecha.
| Parámetro | Endpoint | Usa en su lugar | Obsoleto desde | Retirada |
|---|---|---|---|---|
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 (Cuerpo JSON) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
prefer_cache (Cuerpo JSON) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
options.skip_cache (Cuerpo JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache_skip (Cuerpo JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache-skip (Cuerpo 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 obsolescencias
Una solicitud que usa un alias obsoleto recibe estas cabeceras de respuesta. El cuerpo de la respuesta no cambia.
Deprecation: la fecha en que el alias quedó obsoleto, como@seguido de segundos Unix (RFC 9745).Sunset: la fecha más temprana en que el alias puede dejar de funcionar (RFC 8594).Link: un enlace a esta página conrel="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"Los navegadores pueden leer las tres cabeceras. Regístralas o configura una alerta sobre Deprecation para encontrar el código que debe actualizarse antes de la fecha de retirada.
Cada obsolescencia también se anuncia en el registro de cambios de la API.