Wersjonowanie i wycofywanie funkcji
Wersja API jest częścią ścieżki, na przykład /v1/status . W obrębie wersji istniejące żądania nadal działają.
Wersjonowanie i wycofywanie funkcji
Wersja API jest częścią ścieżki, na przykład /v1/status. W obrębie wersji istniejące żądania nadal działają. Ta strona wyjaśnia, co może się zmienić, z jakim wyprzedzeniem jesteś informowany i jak znaleźć żądania wymagające aktualizacji.
Zmiany bez uprzedzenia
Nowe endpointy, opcjonalne parametry, pola odpowiedzi, wartości w istniejących listach opcji, nagłówki odpowiedzi i kody błędów mogą być dodawane w dowolnym momencie. Pisz klienty, które ignorują nieznane pola i poprawnie obsługują nowe wartości.
Zmiany niezgodne wstecz
Usunięcie lub zmiana nazwy endpointu, parametru albo pola, a także zmiana jego znaczenia, następuje dopiero po co najmniej 12 miesiącach wcześniejszego powiadomienia. W tym czasie stara forma nadal działa, odpowiedzi na żądania, które jej używają, zawierają nagłówki Deprecation i Sunset, a zmiana jest ujęta w dzienniku zmian.
Nazewnictwo kluczy odpowiedzi
Większość kluczy odpowiedzi jest w snake_case. Aby otrzymać wszystkie klucze w snake_case, dodaj naming=snake lub wyślij nagłówek DomScan-Naming: snake. Jest to opcja do samodzielnego włączenia, więc domyślne odpowiedzi się nie zmieniają. Zobacz klucze snake_case.
Wycofywane aliasy
Te starsze parametry nadal działają. Każdy z nich działa co najmniej do swojej daty sunset. Przejdź na zamiennik przed tą datą.
| Parametr | Endpoint | Użyj zamiast tego | Wycofany | 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 (Treść JSON) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
prefer_cache (Treść JSON) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
options.skip_cache (Treść JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache_skip (Treść JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache-skip (Treść 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 (wartość liczbowa) | 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 |
Wykrywanie wycofań
Żądanie korzystające z wycofywanego aliasu otrzymuje te nagłówki odpowiedzi. Treść odpowiedzi pozostaje taka sama.
Deprecation: data wycofania aliasu, zapisana jako@i liczba sekund Unix (RFC 9745).Sunset: najwcześniejsza data, od której alias może przestać działać (RFC 8594).Link: link do tej strony zrel="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"Przeglądarki potrafią odczytać wszystkie trzy nagłówki. Rejestruj je w logach lub ustaw alert na Deprecation, aby znaleźć kod wymagający aktualizacji przed datą sunset.
Każde wycofanie jest także ogłaszane w dzienniku zmian API.