Versionierung und Deprecations
Die API-Version ist Teil des Pfads, zum Beispiel /v1/status . Innerhalb einer Version funktionieren bestehende Anfragen weiter.
Versionierung und Deprecations
Die API-Version ist Teil des Pfads, zum Beispiel /v1/status. Innerhalb einer Version funktionieren bestehende Anfragen weiter. Diese Seite erklärt, was sich ändern kann, wie viel Vorlaufzeit Sie erhalten und wie Sie Anfragen finden, die angepasst werden müssen.
Änderungen ohne Vorankündigung
Neue Endpunkte, optionale Parameter, Antwortfelder, Werte in bestehenden Auswahllisten, Antwort-Header und Fehlercodes können jederzeit hinzugefügt werden. Schreiben Sie Clients so, dass sie unbekannte Felder ignorieren und neue Werte sauber behandeln.
Breaking Changes
Das Entfernen oder Umbenennen eines Endpunkts, Parameters oder Felds oder die Änderung seiner Bedeutung erfolgt erst nach mindestens 12 Monaten Vorankündigung. In dieser Zeit funktioniert die alte Form weiter, Antworten auf Anfragen, die sie verwenden, enthalten die Header Deprecation und Sunset, und die Änderung wird im Changelog aufgeführt.
Benennung der Antwortschlüssel
Die meisten Antwortschlüssel sind snake_case. Um jeden Schlüssel in snake_case zu erhalten, fügen Sie naming=snake hinzu oder senden Sie den Header DomScan-Naming: snake. Das ist ein Opt-in, die Standardantworten ändern sich also nicht. Siehe snake_case-Schlüssel.
Veraltete Aliase
Diese älteren Parameter funktionieren weiterhin. Jeder von ihnen funktioniert mindestens bis zu seinem Sunset-Datum. Wechseln Sie vorher zum Ersatz.
| Parameter | Endpunkt | Stattdessen verwenden | Veraltet seit | 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 (numerischer Wert) | 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 erkennen
Eine Anfrage, die einen veralteten Alias verwendet, erhält diese Antwort-Header. Der Antwort-Body bleibt unverändert.
Deprecation: das Datum, an dem der Alias als veraltet markiert wurde, als@gefolgt von Unix-Sekunden (RFC 9745).Sunset: das früheste Datum, an dem der Alias nicht mehr funktionieren darf (RFC 8594).Link: ein Link auf diese Seite mitrel="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"Browser können alle drei Header auslesen. Protokollieren Sie sie oder richten Sie einen Alarm auf Deprecation ein, um Code zu finden, der vor dem Sunset-Datum aktualisiert werden muss.
Jede Deprecation wird außerdem im API-Changelog angekündigt.