API updates - 17 October 2026
Version 2 is current. Version 1 remains supported. This guide is based on the published live schemas, not on screen labels alone.
What changed
The v2 schema has 358 method/path operations. Compared with v1 after normalizing the version prefix, it adds 24 operations and omits two government-settings operations. Do not migrate government configuration writes by replacing v1 with v2.
New capabilities
Capabilities, sanitized communications readiness, expiry monitoring and government readiness. Readiness is a configuration/status summary; it does not establish a government connection or send a message.
Request workflows
Leave, excuses, time claims, employee services and leave extensions have collection, detail, review-action and approved-document operations. The key and current reviewer must meet the documented permissions and workflow rules.
Keys and scopes
Create the key under Settings > API integrations. Use a server-side Authorization: Bearer header. Keep the key out of browser code and URLs. Read, write and approval grants are separate, and company, plan and expiry checks still apply.
Migration checks
Read the target operation in the live schema. Confirm filters, pagination, response fields and permission grants. Test with the least privilege required. Check whether a create succeeded before retrying an uncertain response.
Web features and API contracts
Monthly Reports supports one employee, selected employees and all employees in the web workspace. That does not create a corresponding public API route. Use only endpoints listed in the published schema.
Time and rate limits
Rate limits use UTC-minute windows. Follow endpoint-specific pagination. Read timestamps with their timezone; numeric durations are minutes unless the schema specifies another unit.
Remote Work agent API
Added to the reference on 18 October 2026. Remote Work uses the /api/remote/v1 protocol; the current documented Windows agent release is 0.3.4. It is separate from the integration API v1/v2 and their scoped integration keys.
Read the agent sign-in, explicit company-notice acknowledgment, device credential, tasks, sessions and Agent Health operations. Device health sharing is optional and records only the latest disclosed snapshot. Company add-on, employee arrangement, policy and data-readiness checks still apply.
Agent device tokens are not portal sessions or integration keys. Portal management uses the employee or manager’s signed-in workspace and role. Public installer downloads and the schema do not start tracking.
تحديثات واجهة البرمجة - 17 أكتوبر 2026
الإصدار الثاني هو الإصدار الحالي، ويظل الإصدار الأول مدعوماً. يستند هذا الدليل إلى المخططات الحية المنشورة، ولا يستنتج مسارات البرمجة من أسماء الشاشات.
واجهة وكيل العمل عن بعد
أُضيفت إلى المرجع في ١٨ أكتوبر ٢٠٢٦. تستخدم واجهة العمل عن بعد البروتوكول /api/remote/v1؛ والإصدار الحالي الموثّق لوكيل ويندوز هو 0.3.4. وهي منفصلة عن الإصدارين الأول والثاني لواجهة التكامل ومفاتيحهما محدودة الصلاحيات.
اطّلع على عمليات تسجيل دخول الوكيل والإقرار الصريح بإشعار الشركة وبيانات اعتماد الجهاز والمهام والجلسات وسلامة الجهاز. مشاركة سلامة الجهاز اختيارية وتحتفظ بآخر قراءة مُعلنة فقط. تبقى متطلبات إضافة الشركة وترتيب الموظف والسياسة وجاهزية البيانات مطبّقة.
رموز الجهاز ليست جلسات البوابة أو مفاتيح التكامل. تعتمد إدارة البوابة على مساحة العمل المسجّلة وصلاحية الموظف أو المدير. لا يبدأ تنزيل المثبّت أو المخطط العام تتبع العمل.
ما الذي تغيّر؟
يتضمن مخطط الإصدار الثاني 358 عملية حسب طريقة الطلب والمسار. وبمقارنة الإصدارين بعد توحيد بادئة الإصدار، أضيفت 24 عملية ولم تُدرج عمليتان لإعدادات الجهات الحكومية. لا تنقل عمليات كتابة الإعدادات الحكومية بمجرد استبدال رقم الإصدار.
القدرات الجديدة
عرض القدرات وجاهزية الاتصالات وملخصات انتهاء المستندات والجاهزية الحكومية. الجاهزية وصف للإعداد والحالة، ولا تنشئ اتصالاً حكومياً ولا ترسل رسالة.
مسارات الطلبات
تتوفر عمليات القوائم والتفاصيل والمراجعة والمستند المعتمد للإجازات والتبريرات ومطالبات الوقت وخدمات الموظفين وتمديد الإجازات. يجب استيفاء صلاحيات المفتاح والمراجع وقواعد مسار العمل.
المفاتيح والصلاحيات
أنشئ المفتاح من الإعدادات ثم تكاملات API. أرسله من الخادم ضمن ترويسة Authorization: Bearer. لا تضعه في المتصفح أو الروابط. صلاحيات القراءة والكتابة والموافقة مستقلة، مع استمرار التحقق من الشركة والباقة والانتهاء.
قبل الانتقال
راجع العملية المستهدفة في المخطط الحي، والمرشحات وتقسيم النتائج والحقول والصلاحيات. اختبر بأقل صلاحية مطلوبة. تحقّق من نجاح الإنشاء قبل إعادة طلب غير محسوم النتيجة.
الشاشة وعقد التكامل
تدعم التقارير الشهرية في الموقع موظفاً واحداً أو مجموعة أو الجميع. لا يعني ذلك وجود مسار عام مماثل في واجهة البرمجة. استخدم المسارات المدرجة في المخطط المنشور فقط.
الوقت وحدود الطلبات
تستخدم حدود الطلبات نوافذ الدقيقة بتوقيت UTC. اتّبع تقسيم النتائج الخاص بالمسار، واقرأ المنطقة الزمنية مع الطابع الزمني. المدد الرقمية بالدقائق ما لم يحدد المخطط وحدة أخرى.