إدارة الإصدارات وإيقاف الدعم
إصدار واجهة API جزء من المسار، مثل /v1/status . وضمن الإصدار الواحد تستمر الطلبات الحالية في العمل.
إدارة الإصدارات وإيقاف الدعم
إصدار واجهة API جزء من المسار، مثل /v1/status. وضمن الإصدار الواحد تستمر الطلبات الحالية في العمل. توضح هذه الصفحة ما الذي يمكن أن يتغير، ومدة الإشعار المسبق التي تحصل عليها، وكيف تعثر على الطلبات التي تحتاج إلى تحديث.
تغييرات دون إشعار مسبق
يمكن إضافة نقاط نهاية جديدة ومعاملات اختيارية وحقول استجابة وقيم جديدة في قوائم الخيارات الحالية وترويسات استجابة ورموز أخطاء في أي وقت. اكتب عملاءك بحيث يتجاهلوا الحقول التي لا يعرفونها ويتعاملوا بمرونة مع القيم الجديدة.
التغييرات غير المتوافقة
لا تتم إزالة نقطة نهاية أو معامل أو حقل أو إعادة تسميته، ولا يتغير معناه، إلا بعد إشعار مسبق مدته 12 شهرًا على الأقل. وخلال هذه المدة يستمر الشكل القديم في العمل، وتحمل الاستجابات للطلبات التي تستخدمه الترويستين Deprecation وSunset، ويُدرج التغيير في سجل التغييرات.
تسمية مفاتيح الاستجابة
معظم مفاتيح الاستجابة مكتوبة بنمط snake_case. لتحصل على كل المفاتيح بنمط snake_case، أضف naming=snake أو أرسل الترويسة DomScan-Naming: snake. هذا الخيار اختياري، لذا لا تتغير الاستجابات الافتراضية. راجع مفاتيح snake_case.
الأسماء البديلة المهملة
ما زالت هذه المعاملات القديمة تعمل. يستمر كل منها في العمل حتى تاريخ إيقافه على الأقل. انتقل إلى البديل قبل ذلك التاريخ.
| المعامل | نقطة النهاية | استخدم بدلًا منه | تاريخ الإهمال | تاريخ الإيقاف |
|---|---|---|---|---|
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) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
prefer_cache (نص JSON) | POST /v1/status/bulk | max_age=2592000 | 2026-10-10 | 2027-10-10 |
options.skip_cache (نص JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache_skip (نص JSON) | POST /v1/status/bulk | max_age=0 | 2026-10-10 | 2027-10-10 |
options.cache-skip (نص 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 (قيمة رقمية) | 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 |
اكتشاف الإهمال
يتلقى الطلب الذي يستخدم اسمًا بديلًا مهملًا ترويسات الاستجابة التالية. ويبقى نص الاستجابة كما هو.
Deprecation: تاريخ إهمال الاسم البديل، بصيغة@متبوعة بالثواني منذ حقبة Unix (RFC 9745).Sunset: أبكر تاريخ قد يتوقف فيه الاسم البديل عن العمل (RFC 8594).Link: رابط إلى هذه الصفحة مع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"يمكن للمتصفحات قراءة الترويسات الثلاث جميعها. سجّل الترويسة Deprecation أو اضبط تنبيهًا عليها لتعثر على الشيفرة التي تحتاج إلى تحديث قبل تاريخ الإيقاف.
يُعلن عن كل إهمال أيضًا في سجل تغييرات API.