توثيق API

الفئات:

الفئات:

الاتصال والعمل مع واجهة برمجة تطبيقات Shifton

واجهة برمجة التطبيقات Shifton تمنحك الوصول إلى جميع الميزات الرئيسية للمنصة — من إدارة الجداول إلى التكامل مع إدارة الموارد البشرية , الرواتب، و أنظمة التحليلات الخارجية.
باستخدام واجهة برمجة التطبيقات، يمكنك أتمتة العمليات وربط Shifton بخدمات الشركة الداخلية.


وثائق واجهة برمجة التطبيقات

نحن ندعم نسختين من وثائقنا:


البدء

الحصول على مفتاح API

في إعدادات شركتك على منصة Shifton، قم بإنشاء مفتاح API.
يتم التفويض عبر الرأس:

Authorization: Bearer {your_api_key}

قم بإجراء الطلب الأول

على سبيل المثال، لاسترداد قائمة الموظفين:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

مثال على الاستجابة:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

دمج واجهة برمجة التطبيقات في سير العمل الخاص بك

  • إنشاء وتعديل الشفتات تلقائيًا

  • إدارة طلبات الإجازات المرضية والإجازات السنوية

  • تصدير البيانات إلى أنظمة الرواتب

  • بناء لوحات القيادة والتقارير المخصصة


قدرات API الأساسية

  • الموظفين – إضافة، تحرير، وإدارة الأدوار

  • الجداول – إنشاء، تعديل الشفت، تخطيط العمل

  • الإجازات والغيابات – إدارة طلبات الإجازات والغياب المرضي

  • التقارير – تصدير بيانات الوقت، الرواتب، والحضور


أكواد الأخطاء

يستخدم Shifton API أكواد حالة HTTP القياسية:

  • 200 — طلب ناجح

  • 201 — تم إنشاء الكائن بنجاح

  • 400 — بارامترات غير صالحة

  • 401 — خطأ في التفويض (مفتاح API غير صالح)

  • 403 — تم رفض الوصول

  • 404 — المورد غير موجود

  • 500 — خطأ في الخادم


نصائح الاستخدام

  • دائمًا استخدم إصدار API الجديد للتكاملات الجديدة

  • استخدام Postman أو curl للاختبار

  • احترام القيود المفروضة على المعدلات لتجنب الحظر

  • تحديث التكاملات التي لا تزال تعتمد على الوثائق القديمة


شارك هذا المنشور