انتقل إلى المحتوى
مهنارو
مركز المساعدة

مرجع الـ API حسب القسم

أهم طلبات كل قسم مع الصلاحية التي تحتاجها، وكيف تقرأ المرجع الكامل المولَّد من الكود، وملف OpenAPI لـ Postman.

في مهنارو أكثر من 900 طلب. هذه الصفحة تعرض ما تبدأ به أغلب التكاملات، قسماً قسماً. والمرجع الكامل يعرض كل الطلبات، مولَّداً من الكود فهو مطابق للخادم دائماً.

في المسارات أدناه {company} رقم شركتك، وبقية {…} أرقام السجلات. «لا يوجد» في عمود الصلاحية تعني أن أي مستخدم نشط في الشركة يستطيع استدعاءه، ويرى سجلاته فقط أو ما يحق له رؤيته. الترويسات في البدء.

كيف تستخدم المرجع الكامل

  • ابحث في المربع أعلى القائمة الجانبية: كلمة من المسار، أو صلاحية (leaves.view)، أو وصف ("payslip").
  • الأقسام هي أول جزء من المسار بعد الشركة: employees وleaves وpayroll-runs وغيرها. لكل قسم رابط تستطيع مشاركته، مثل قسم الموظفين.
  • افتح أي طلب لترى وصفه، ومن يستطيع استدعاءه (الدخول، والصلاحية، والوحدة، وحد الطلبات)، ومعاملات المسار، ومعاملات الاستعلام أو حقول البيانات التي يتحقق منها الكود مع قواعدها، ومثال curl جاهز للنسخ.
  • حقول البيانات تُقرأ من تحقق الكود. بعض الأقسام تتحقق من حقول إضافية في مراحل أعمق؛ عندها يذكرها الوصف، وتشرح مقالات القسم نفسه النماذج.

OpenAPI وPostman

الواجهة كلها متاحة أيضاً كملف OpenAPI 3.0، مولَّد من نفس الكود: نزّل openapi.json.

  • Postman: Import ← Upload files ← اختر mihnaro-openapi.json. اجعل مصادقة المجموعة Bearer Token بمفتاحك، وضع رقم شركتك مكان {company}.
  • Insomnia وBruno وHoppscotch ومولّدات العملاء (OpenAPI Generator وopenapi-typescript) تقرأ نفس الملف.
  • كل طلب فيه x-permissions وx-modules وx-rate-limit-per-minute.

الحساب والشركة

الطريقة المسار الصلاحية ماذا
POST /api/v1/app/token لا يوجد (بلا رمز) الدخول والحصول على رمز
DELETE /api/v1/app/token لا يوجد الخروج وإلغاء هذا الرمز
GET /api/v1/app/me لا يوجد (برمز دخول فقط، لا بمفتاح API) حسابك وشركاتك
GET /api/v1/app/companies/{company} لا يوجد الترخيص والوحدات والفروع التي تعطيك إياها الشركة
GET /api/v1/app/companies/{company}/branch لا يوجد الفرع الذي تعمل فيه
PUT /api/v1/app/companies/{company}/branch لا يوجد تبديل الفرع: {"branch": 77} أو {"branch": "all"}

الموظفون

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/employees employees.view القائمة: search وstatus وemployee_number وbranch_id وsalary_status وper_page
GET /api/v1/app/companies/{company}/employees/{employee} employees.view موظف واحد
GET /api/v1/app/companies/{company}/employees/by-number/{number} employees.view موظف واحد برقمه الوظيفي
POST /api/v1/app/companies/{company}/employees employees.create إضافة موظف (ضمن عدد الموظفين في الترخيص)
PATCH /api/v1/app/companies/{company}/employees/{employee} employees.edit تعديل الحقول المرسلة
GET /api/v1/app/companies/{company}/directory employees.view أو self.directory.view دليل الشركة

كل طلبات الموظفين: الملف، والبيانات المهنية، وإنهاء الخدمة، وإعادة التعيين، وحزم الرواتب وغيرها.

الحضور والبصمة

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/me/attendance self.attendance.view شهر حضوري وسجلات اليوم
POST /api/v1/app/companies/{company}/attendance/clock-in self.clock بصمة دخول (مع فحوص أمان البصمة)
POST /api/v1/app/companies/{company}/attendance/clock-out self.clock بصمة خروج
GET /api/v1/app/companies/{company}/attendance/records attendance.view السجلات: from وto وemployee وshift وstate
POST /api/v1/app/companies/{company}/attendance/records attendance.records.manage إضافة سجل، أو تصحيح يوم بـ "replace": true
GET /api/v1/app/companies/{company}/attendance/team attendance.view شهر الفريق، مجاميع لكل موظف
GET /api/v1/app/companies/{company}/attendance/today attendance.view يوم الفريق: العدادات وحالة كل شخص
GET /api/v1/app/companies/{company}/attendance/punch-log attendance.security.review كل بصمة مع فحوص أمانها

كل طلبات الحضور، والمناوبات وجداول الدوام والعمل الإضافي.

الإجازات

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/me/leaves self.leaves.view أرصدتي هذه السنة (أو ?year=) وطلباتي
POST /api/v1/app/companies/{company}/leaves self.leaves.request طلب إجازة: leave_type_id وstart_date وend_date وreason (multipart مع attachment إن احتاجه النوع)
GET /api/v1/app/companies/{company}/leaves/{leave} leaves.manage أو leaves.view أو self.approvals.decide أو self.leaves.view (إجازتي، أو leaves.view) إجازة واحدة مع رصيدها
POST /api/v1/app/companies/{company}/leaves/{leave}/withdraw leaves.manage أو self.leaves.cancel سحب إجازتي
POST /api/v1/app/companies/{company}/leaves/{leave}/decide leaves.manage أو requests.manage أو self.approvals.decide (صاحب الموافقة في الخطوة) decision: approved أو rejected، وdecision_note
GET /api/v1/app/companies/{company}/team-leaves leaves.view إجازات الفريق: status وtype وemployee وfrom وto
POST /api/v1/app/companies/{company}/team-leaves leaves.record الموارد البشرية تسجّل إجازة موافقاً عليها لموظف
GET /api/v1/app/companies/{company}/leave-types leave_setup.manage أنواع الإجازات

كل طلبات الإجازات، والأرصدة والتعديلات.

الرواتب

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/me/payslips self.payslips.view كشوف راتبي (المسيرات المعتمدة فقط)
GET /api/v1/app/companies/{company}/payslips/{payslip} payroll.runs.view or self.payslips.view كشف راتب واحد
GET /api/v1/app/companies/{company}/payslips/{payslip}/pdf payroll.runs.view or self.payslips.download كشف الراتب كملف PDF
GET /api/v1/app/companies/{company}/payroll-runs payroll.runs.view مسيرات الرواتب، الأحدث أولاً
GET /api/v1/app/companies/{company}/payroll-runs/{run} payroll.runs.view مسير مع كشوفه
POST /api/v1/app/companies/{company}/payroll-runs/{run}/approve payroll.runs.approve اعتماد مسير (أو إرساله في سلسلة موافقاته)
GET /api/v1/app/companies/{company}/payroll/{month} payroll.runs.view المسير العادي المعتمد لشهر (2026-10)؛ 404 قبل اعتماده

كل طلبات الرواتب، والمعاملات المالية والقروض والرواتب.

الطلبات والموافقات

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/me/requests self.requests.view طلباتي
POST /api/v1/app/companies/{company}/requests/{type} requests.manage أو self.requests.file تقديم طلب من نوع، بحقوله (ومرفق attachment)
POST /api/v1/app/companies/{company}/requests/{employeeRequest}/withdraw requests.manage أو self.requests.cancel سحب طلبي المعلّق
POST /api/v1/app/companies/{company}/requests/{employeeRequest}/decide leaves.manage أو requests.manage أو self.approvals.decide (صاحب الموافقة في الخطوة) decision: approved أو rejected، وdecision_note
GET /api/v1/app/companies/{company}/approvals requests.manage أو requests.view أو self.approvals.decide صفحة الموافقات: tab وstatus وtype
POST /api/v1/app/companies/{company}/approvals/bulk requests.manage أو requests.view أو self.approvals.decide الموافقة على عدة عناصر أو رفضها معاً

كل طلبات الطلبات، وأنواع الطلبات والموافقات.

الإعلانات

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/announcements announcements.manage أو self.announcements الإعلانات التي يحق لهذا الشخص قراءتها: q وper_page
GET /api/v1/app/companies/{company}/announcements/{announcement} announcements.manage أو self.announcements إعلان واحد
POST /api/v1/app/companies/{company}/announcements announcements.create النشر: title وbody بالشكل {"en", "ar"}، وpinned وstarts_on وexpires_on
DELETE /api/v1/app/companies/{company}/announcements/{announcement} announcements.delete الحذف

كل طلبات الإعلانات، والفعاليات والمهام.

الوثائق

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/documents employees.view_sensitive أو self.documents.view (حسب ما يحق لك رؤيته) وثائق الموظفين والشركة
POST /api/v1/app/companies/{company}/documents employees.view_sensitive أو self.documents.upload (حسب ما يحق لك إدارته) رفع وثيقة (multipart)
GET /api/v1/app/companies/{company}/documents/{document}/download لا يوجد تنزيل الملف

كل طلبات الوثائق، وكتب الموارد البشرية.

الأجهزة

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/devices devices.manage أجهزة البصمة والدخول
GET /api/v1/app/companies/{company}/devices/{device} devices.manage جهاز واحد
POST /api/v1/app/companies/{company}/devices/{device}/actions/{action} devices.manage إرسال أمر إلى الجهاز
GET /api/v1/app/companies/{company}/devices/{device}/users devices.manage الأشخاص على الجهاز

كل طلبات الأجهزة، وأحداث الأبواب.

الـ Webhooks والتقارير

الطريقة المسار الصلاحية ماذا
GET /api/v1/app/companies/{company}/webhooks integrations.api_keys.manage الـ webhooks (برمز دخول فقط، لا بمفتاح API)
GET /api/v1/app/companies/{company}/webhook-deliveries integrations.api_keys.manage سجل التسليم
GET /api/v1/app/companies/{company}/reports لا يوجد (التقارير التي يسمح بها دورك) التقارير التي تستطيع تشغيلها

انظر الـ Webhooks للأحداث والتواقيع، وقسم التقارير لتشغيل التقارير وتصديرها.

آخر تحديث:

ما زلت تحتاج مساعدة؟

فريق الدعم يجيبك بالعربية والإنجليزية.

راسل الدعم

نستخدم ملفات تعريف الارتباط لنفهم كيف يُستخدم الموقع. يمكنك القبول أو الرفض.