YYYY-MM-DD). وتضمّن وثيقة OpenAPI المنشورة إصدار العقد الخاص بها في
info["x-contract-version"]، وتحدد كل عملية مرحلة دورة حياتها في
x-lifecycle-stage (preview أو compatibility أو ga).
- تتوفر المواصفات الحالية دائمًا على
/v1-reference/openapi-v1.json. - تتوفر لقطات المرجع الخاصة بكل إصدار على
/v1-reference/openapi/<version>.json، على سبيل المثال/v1-reference/openapi/2026-07-01.json.
تحديثات التوثيق
2026-08-25 — تذكر أدلة/v1 وقائمة servers في OpenAPI الآن
المضيفين الإقليميين الفعليين في الولايات المتحدة والاتحاد الأوروبي. وهذا توضيح في التوثيق فقط. ولم يتغير إصدار
العقد. راجع المناطق.
2026-07-01
تدعم واجهة/v1 Public API هذا الإصدار من العقد. يمكنك تثبيته باستخدام
Living-Security-Version: 2026-07-01، أو استخدام الإصدار الافتراضي المعيَّن
لحساب الخدمة الخاص بك.
راجع البدء السريع لواجهة API لإرسال أول طلب،
والمصادقة لمفاتيح API وOAuth، والمناطق لمعرفة المضيف الصحيح.
2026-08-05
يحدد هذا التاريخ عقد التوافق القديم المنفصل/api/v1.
وهو ليس قيمة Living-Security-Version لواجهة /v1 API الجديدة.
- الأشخاص: البحث عن الأشخاص في المؤسسة (
GET /people/search) واسترجاع عضوية شخص (GET /people/{personId}/membership). - مفاتيح الوصول إلى API: إنشاء مفاتيح الوصول إلى API وعرضها وتدويرها وإلغاؤها
(
POST /access-keysوGET /access-keysوPOST /access-keys/{id}/rotateوDELETE /access-keys/{id}).
compatibility. راجع نظرة عامة على Public API للاطلاع على
المصادقة وتقسيم النتائج إلى صفحات ومعالجة الأخطاء، و
سياسة التوافق وإيقاف الدعم
لمعرفة كيفية تطور هذا العقد.