Gestion des versions et dépréciations
La version de l'API fait partie du chemin, par exemple /v1/status . Au sein d'une version, les requêtes existantes continuent de fonctionner.
Gestion des versions et dépréciations
La version de l'API fait partie du chemin, par exemple /v1/status. Au sein d'une version, les requêtes existantes continuent de fonctionner. Cette page explique ce qui peut changer, quel préavis vous recevez et comment repérer les requêtes à mettre à jour.
Changements sans préavis
De nouveaux endpoints, paramètres facultatifs, champs de réponse, valeurs dans des listes d'options existantes, en-têtes de réponse et codes d'erreur peuvent être ajoutés à tout moment. Écrivez des clients qui ignorent les champs qu'ils ne connaissent pas et gèrent correctement les nouvelles valeurs.
Changements incompatibles
La suppression ou le renommage d'un endpoint, d'un paramètre ou d'un champ, ou la modification de sa signification, n'intervient qu'après un préavis d'au moins 12 mois. Pendant cette période, l'ancienne forme continue de fonctionner, les réponses aux requêtes qui l'utilisent portent les en-têtes Deprecation et Sunset, et le changement est indiqué dans le journal des modifications.
Nommage des clés de réponse
La plupart des clés de réponse sont en snake_case. Pour recevoir toutes les clés en snake_case, ajoutez naming=snake ou envoyez l'en-tête DomScan-Naming: snake. C'est une option à activer, donc les réponses par défaut ne changent pas. Voir clés snake_case.
Alias dépréciés
Ces anciens paramètres fonctionnent toujours. Chacun reste fonctionnel au moins jusqu'à sa date de retrait. Passez au remplaçant avant cette date.
| Paramètre | Endpoint | À utiliser à la place | Déprécié le | Retrait |
|---|---|---|---|---|
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 (Corps JSON) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
prefer_cache (Corps JSON) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
options.skip_cache (Corps JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache_skip (Corps JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache-skip (Corps 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 (valeur numérique) | 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 |
Détecter les dépréciations
Une requête qui utilise un alias déprécié reçoit ces en-têtes de réponse. Le corps de la réponse reste identique.
Deprecation: la date à laquelle l'alias a été déprécié, sous la forme@suivi de secondes Unix (RFC 9745).Sunset: la date au plus tôt à laquelle l'alias peut cesser de fonctionner (RFC 8594).Link: un lien vers cette page avecrel="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"Les navigateurs peuvent lire les trois en-têtes. Journalisez-les ou configurez une alerte sur Deprecation pour trouver le code à mettre à jour avant la date de retrait.
Chaque dépréciation est également annoncée dans le journal des modifications de l'API.