Sürümleme ve kullanımdan kaldırmalar
API sürümü yolun bir parçasıdır, örneğin /v1/status . Bir sürüm içinde mevcut istekler çalışmaya devam eder.
Sürümleme ve kullanımdan kaldırmalar
API sürümü yolun bir parçasıdır, örneğin /v1/status. Bir sürüm içinde mevcut istekler çalışmaya devam eder. Bu sayfa nelerin değişebileceğini, ne kadar önceden bilgilendirileceğinizi ve güncellenmesi gereken istekleri nasıl bulacağınızı açıklar.
Önceden bildirilmeden yapılan değişiklikler
Yeni uç noktalar, isteğe bağlı parametreler, yanıt alanları, mevcut seçenek listelerindeki değerler, yanıt başlıkları ve hata kodları istenen zamanda eklenebilir. Tanımadığı alanları yok sayan ve yeni değerleri sorunsuz işleyen istemciler yazın.
Geriye dönük uyumsuz değişiklikler
Bir uç noktanın, parametrenin veya alanın kaldırılması ya da yeniden adlandırılması veya anlamının değiştirilmesi yalnızca en az 12 ay önceden bildirimde bulunulduktan sonra yapılır. Bu sürede eski biçim çalışmaya devam eder, onu kullanan isteklerin yanıtları Deprecation ve Sunset başlıklarını taşır ve değişiklik değişiklik günlüğünde listelenir.
Yanıt anahtarı adlandırması
Yanıt anahtarlarının çoğu snake_case biçimindedir. Tüm anahtarları snake_case olarak almak için naming=snake ekleyin veya DomScan-Naming: snake başlığını gönderin. Bu isteğe bağlı bir tercihtir, dolayısıyla varsayılan yanıtlar değişmez. Bkz. snake_case anahtarları.
Kullanımdan kaldırılan takma adlar
Bu eski parametreler hâlâ çalışmaktadır. Her biri en azından sunset tarihine kadar çalışmaya devam eder. Bu tarihten önce yerine kullanılacak olana geçin.
| Parametre | Uç nokta | Bunun yerine kullanın | Kullanımdan kaldırma | 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 gövdesi) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
prefer_cache (JSON gövdesi) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
options.skip_cache (JSON gövdesi) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache_skip (JSON gövdesi) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache-skip (JSON gövdesi) | 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 (sayısal değer) | 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 |
Kullanımdan kaldırmaları tespit etme
Kullanımdan kaldırılmış bir takma adı kullanan istek bu yanıt başlıklarını alır. Yanıt gövdesi aynı kalır.
Deprecation: takma adın kullanımdan kaldırıldığı tarih;@ve ardından Unix saniyeleri olarak yazılır (RFC 9745).Sunset: takma adın çalışmayı bırakabileceği en erken tarih (RFC 8594).Link:rel="deprecation"ile bu sayfaya giden bir bağlantı.
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"Tarayıcılar üç başlığı da okuyabilir. Sunset tarihinden önce güncellenmesi gereken kodu bulmak için bunları günlüğe kaydedin veya Deprecation için uyarı kurun.
Her kullanımdan kaldırma ayrıca API değişiklik günlüğü içinde duyurulur.