Ontwikkelaarsreferentie

Versiebeheer en deprecations

De API-versie maakt deel uit van het pad, bijvoorbeeld /v1/status . Binnen een versie blijven bestaande verzoeken werken.

Versiebeheer en deprecations

De API-versie maakt deel uit van het pad, bijvoorbeeld /v1/status. Binnen een versie blijven bestaande verzoeken werken. Deze pagina legt uit wat er kan veranderen, hoeveel voorafgaande kennisgeving u krijgt en hoe u verzoeken vindt die moeten worden bijgewerkt.

Wijzigingen zonder voorafgaande kennisgeving

Nieuwe endpoints, optionele parameters, responsevelden, waarden in bestaande lijsten met opties, responseheaders en foutcodes kunnen op elk moment worden toegevoegd. Schrijf clients die onbekende velden negeren en nieuwe waarden netjes afhandelen.

Brekende wijzigingen

Het verwijderen of hernoemen van een endpoint, parameter of veld, of het wijzigen van de betekenis ervan, gebeurt pas na minimaal 12 maanden voorafgaande kennisgeving. In die periode blijft de oude vorm werken, bevatten responses op verzoeken die deze gebruiken de headers Deprecation en Sunset, en wordt de wijziging vermeld in de changelog.

Naamgeving van responsesleutels

De meeste responsesleutels zijn snake_case. Voeg naming=snake toe of stuur de header DomScan-Naming: snake mee om alle sleutels in snake_case te ontvangen. Dit is een opt-in, dus de standaardresponses veranderen niet. Zie snake_case-sleutels.

Verouderde aliassen

Deze oudere parameters werken nog steeds. Elk blijft werken tot minstens de sunset-datum. Stap vóór die tijd over op de vervanger.

Parameter	Endpoint	Gebruik in plaats daarvan	Verouderd sinds	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` (numerieke waarde)	`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

Deprecations opsporen

Een verzoek dat een verouderde alias gebruikt, ontvangt deze responseheaders. De responsebody blijft hetzelfde.

Deprecation: de datum waarop de alias verouderd werd verklaard, als @ gevolgd door Unix-seconden (RFC 9745).
Sunset: de vroegste datum waarop de alias kan ophouden te werken (RFC 8594).
Link: een link naar deze pagina met 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"

Browsers kunnen alle drie de headers lezen. Log ze, of stel een waarschuwing in op Deprecation, om code te vinden die vóór de sunset-datum moet worden bijgewerkt.

Elke deprecation wordt ook aangekondigd in de API-changelog.

Ondersteuning

Versiebeheer en deprecations