Versionshantering och utfasningar
API-versionen ingår i sökvägen, till exempel /v1/status . Inom en version fortsätter befintliga förfrågningar att fungera.
Versionshantering och utfasningar
API-versionen ingår i sökvägen, till exempel /v1/status. Inom en version fortsätter befintliga förfrågningar att fungera. Den här sidan förklarar vad som kan ändras, hur lång varsel du får och hur du hittar förfrågningar som behöver uppdateras.
Ändringar utan varsel
Nya endpoints, valfria parametrar, fält i svar, värden i befintliga listor med alternativ, svarsheaders och felkoder kan läggas till när som helst. Skriv klienter som ignorerar fält de inte känner till och hanterar nya värden på ett smidigt sätt.
Brytande ändringar
Att ta bort eller byta namn på en endpoint, parameter eller ett fält, eller ändra dess betydelse, sker först efter minst 12 månaders varsel. Under den tiden fortsätter den gamla formen att fungera, svar på förfrågningar som använder den innehåller headerna Deprecation och Sunset, och ändringen listas i ändringsloggen.
Namngivning av nycklar i svar
De flesta nycklar i svaren är snake_case. Lägg till naming=snake eller skicka headern DomScan-Naming: snake för att få alla nycklar som snake_case. Detta är ett val du själv gör, så standardsvaren ändras inte. Se snake_case-nycklar.
Utfasade alias
De här äldre parametrarna fungerar fortfarande. Var och en fortsätter att fungera till och med minst sitt sunset-datum. Byt till ersättaren före dess.
| Parameter | Endpoint | Använd i stället | Utfasad | Sunset |
|---|---|---|---|---|
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 (JSON-body) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
prefer_cache (JSON-body) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
options.skip_cache (JSON-body) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache_skip (JSON-body) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache-skip (JSON-body) | 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 (numeriskt värde) | 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 |
Upptäcka utfasningar
En förfrågan som använder ett utfasat alias får dessa svarsheaders. Svarets innehåll förblir detsamma.
Deprecation: datumet då aliaset fasades ut, som@följt av Unix-sekunder (RFC 9745).Sunset: det tidigaste datumet då aliaset kan sluta fungera (RFC 8594).Link: en länk till den här sidan medrel="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"Webbläsare kan läsa alla tre headerna. Logga dem eller skapa en avisering på Deprecation för att hitta kod som behöver uppdateras före sunset-datumet.
Varje utfasning aviseras också i API-ändringsloggen.