مستندات API

المصادقة

تُصادَق كل طلبية باستخدام رمز حامل (bearer token). أنشئ واحدًا في لوحة معلوماتك ضمن الإعدادات ← مفاتيح API — يُعرض مرة واحدة، لذا انسخه حينها. يرث الرمز أدوار وأذونات المستخدم الذي أنشأه، ومعظم نقاط نهاية الموارد تتطلب أيضاً تفعيل الوحدة المطابقة على خطتك.

ترويسة التفويض

# مرّر رمزك المميز مع كل طلب حليقة https://app.mewayz.com/api/leads \ -ح "Authorization: Bearer 12|aZ8f3a...d92c" \ -H "Accept: application/json"

تفضّل المصادقة برمجيًا؟ POST /api/login مع بريدك الإلكتروني وكلمة المرور يُرجع رمز حامل يمكنك استخدامه بنفس الطريقة، و نشر /api/refresh يدوّرها.

بدء سريع

أنشئ عميلاً محتملاً في نظام إدارة علاقات العملاء في أقل من دقيقة. تعمل واجهة برمجة التطبيقات على البيانات نفسها التي تراها في المنتج — لا توجد طبقة مزامنة منفصلة.

POST /api/lead/create

curl -X مشاركة https://app.mewayz.com/api/lead/create \ -ح "Authorization: Bearer 12|aZ8f3a..." \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "الاسم": "آدا لوفلايس"، "البريد الإلكتروني": "[email protected]" }'

الأخطاء ورموز الحالة

نستخدم رموز حالة HTTP التقليدية. تتضمن أجسام الأخطاء رسالة مقروءة رسالة يمكنك إبرازها مباشرة.

200	OK — نجح الطلب
201	تم الإنشاء — تم إنشاء المورد
401	غير مصرّح — رمز مفقود أو غير صالح
422	غير قابل للمعالجة — فشل التحقق
429	طلبات كثيرة جدًا — لقد وصلت إلى حد المعدل
500	خطأ في الخادم — سنعيده الحالة

حدود المعدّل

تُقيَّد حركة API لإبقاء المنصة سريعة للجميع. إذا تجاوزت الحد فستتلقّى HTTP 429 استجابة — تراجع وأعد المحاولة. الـ Retry-After تخبرك الترويسة متى يمكنك الاستئناف.

المصادقة والجلسة /api/login

سجّل الدخول، أو حدّث رمزك أو ألغِه، وجلب المستخدم المسجّل، وتعديل الملف الشخصي، وقراءة قوائم مستخدمي الموظفين / العملاء / الموردين. (11 نقطة نهاية)

POST	/api/change-password
GET	/api/client-user
DELETE	/api/delete-account
POST	/api/edit-profile
POST	/api/login
POST	/api/logout
POST	/api/refresh
GET	/api/staff-user
POST	/api/upload-photos
GET	/api/user
GET	/api/vendor-user

مفاتيح API /api/v1/settings/api-keys

اعرض رموز الوصول الشخصية الخاصة بك وأنشئها وألغها — المفاتيح نفسها التي تنشئها ضمن الإعدادات → مفاتيح API. (3 نقاط نهاية)

GET	/api/v1/settings/api-keys
POST	/api/v1/settings/api-keys
DELETE	/api/v1/settings/api-keys/{id}

إدارة علاقات العملاء — العملاء المحتملون والصفقات وخط الأنابيب /api/leads

تحكم كامل (إنشاء وقراءة وتحديث وحذف) في العملاء المحتملين والصفقات وخطوط الأنابيب والمراحل والتسميات والمصادر، إضافة إلى مهامها ومكالماتها وملفاتها وملاحظاتها ومنتجاتها. (79 نقطة نهاية)

DELETE	/api/deal-call/delete/{call_id}
POST	/api/deal-call/store
POST	/api/deal-call/update/{call_id}
POST	/api/deal-client/store/{deal_id}
DELETE	/api/deal-client/{deal_id}/delete/{client_id}
POST	/api/deal-discussion/store/{deal_id}
POST	/api/deal-email/store/{deal_id}
POST	/api/deal-file/store/{deal_id}
DELETE	/api/deal-file/{deal_id}/delete/{file_id}
POST	/api/deal-source/store/{deal_id}
DELETE	/api/deal-source/{deal_id}/delete/{source_id}
POST	/api/deal-stage/create
DELETE	/api/deal-stage/delete/{id}
POST	/api/deal-stage/update/{id}
GET	/api/deal-stages
POST	/api/deal-task/create
DELETE	/api/deal-task/delete/{id}
POST	/api/deal-task/update/{id}
POST	/api/deal-user/store/{deal_id}
DELETE	/api/deal-user/{deal_id}/delete/{user_id}
POST	/api/deal/add-label/{id}
POST	/api/deal/assign-products/{deal_id}
POST	/api/deal/create
DELETE	/api/deal/delete/{id}
GET	/api/deal/show/{id}
POST	/api/deal/update/{id}
DELETE	/api/deal/{deal_id}/products/{product_id}
GET	/api/deals
POST	/api/label/create
DELETE	/api/label/delete/{id}
POST	/api/label/update/{id}
GET	/api/labels
DELETE	/api/lead-call/delete/{call_id}
POST	/api/lead-call/store
POST	/api/lead-call/update/{call_id}
POST	/api/lead-discussion/store/{lead_id}
POST	/api/lead-email/store/{lead_id}
POST	/api/lead-file/store/{lead_id}
DELETE	/api/lead-file/{lead_id}/delete/{file_id}
POST	/api/lead-source/store/{lead_id}
DELETE	/api/lead-source/{lead_id}/delete/{source_id}
POST	/api/lead-stage/create
DELETE	/api/lead-stage/delete/{id}
POST	/api/lead-stage/update/{id}
GET	/api/lead-stages
POST	/api/lead-task/create
DELETE	/api/lead-task/delete/{id}
POST	/api/lead-task/update/{id}
POST	/api/lead-user/store/{lead_id}
DELETE	/api/lead-user/{lead_id}/delete/{user_id}
POST	/api/lead/add-label/{id}
POST	/api/lead/assign-products/{lead_id}
POST	/api/lead/convert-to-deal/{id}
POST	/api/lead/create
DELETE	/api/lead/delete/{id}
GET	/api/lead/get-request-data
GET	/api/lead/get-users
POST	/api/lead/home
POST	/api/lead/lead-create-update
POST	/api/lead/lead-delete
POST	/api/lead/lead-details
POST	/api/lead/lead-stage-create-update
POST	/api/lead/lead-stage-update
POST	/api/lead/lead-stages
POST	/api/lead/leadboard
POST	/api/lead/pipeline-create-update
GET	/api/lead/pipelines
GET	/api/lead/show/{id}
POST	/api/lead/update/{id}
DELETE	/api/lead/{lead_id}/products/{product_id}
GET	/api/leads
POST	/api/pipeline/create
DELETE	/api/pipeline/delete/{id}
POST	/api/pipeline/update/{id}
GET	/api/pipelines
POST	/api/source/create
DELETE	/api/source/delete/{id}
POST	/api/source/update/{id}
GET	/api/sources

المبيعات /api/sales/sales-orders

الفرص، وعروض الأسعار، والاجتماعات، وأوامر المبيعات، وعمليات البحث في المستودع. (23 نقطة نهاية)

GET	/api/sales/RequestData
POST	/api/sales/get-warehouse-products
GET	/api/sales/home
DELETE	/api/sales/meeting/destroy/{id}
POST	/api/sales/meeting/store
POST	/api/sales/meeting/update/{id}
GET	/api/sales/meetings
GET	/api/sales/opportunities
DELETE	/api/sales/opportunities/delete/{id}
POST	/api/sales/opportunities/update/{id}
POST	/api/sales/opportunitity/store
POST	/api/sales/parent-records
GET	/api/sales/quotes
DELETE	/api/sales/quotes/destroy/{id}
POST	/api/sales/quotes/store
POST	/api/sales/quotes/update/{id}
GET	/api/sales/quotes/{id}
DELETE	/api/sales/sales-order/delete/{id}
POST	/api/sales/sales-order/store
POST	/api/sales/sales-order/update/{id}
GET	/api/sales/sales-orders
GET	/api/sales/sales-orders/{id}
GET	/api/sales/warehouses

عروض المبيعات /api/sales-proposal

صُغ العروض وأرسلها واقبلها/ارفضها وحوّلها إلى فواتير. (9 نقاط نهاية)

GET	/api/sales-proposal
POST	/api/sales-proposal/accept/{proposal_id}
POST	/api/sales-proposal/convert-to-invoice/{proposal_id}
POST	/api/sales-proposal/create
DELETE	/api/sales-proposal/delete/{proposal_id}
POST	/api/sales-proposal/reject/{proposal_id}
POST	/api/sales-proposal/sent/{proposal_id}
GET	/api/sales-proposal/show/{proposal_id}
POST	/api/sales-proposal/update/{proposal_id}

فواتير المبيعات /api/sales-invoice

عرض فواتير المبيعات وإنشاؤها وتحديثها وحذفها وترحيلها. (6 نقاط نهاية)

GET	/api/sales-invoice
POST	/api/sales-invoice/create
DELETE	/api/sales-invoice/delete/{invoice_id}
POST	/api/sales-invoice/post/{invoice_id}
GET	/api/sales-invoice/show/{invoice_id}
POST	/api/sales-invoice/update/{invoice_id}

مرتجعات فواتير المبيعات /api/sales-invoice-return

أنشئ مرتجعات فواتير المبيعات واعتمدها وأكملها. (6 نقاط نهاية)

GET	/api/sales-invoice-return
POST	/api/sales-invoice-return/approve/{return_id}
POST	/api/sales-invoice-return/complete/{return_id}
POST	/api/sales-invoice-return/create
DELETE	/api/sales-invoice-return/delete/{return_id}
GET	/api/sales-invoice-return/show/{return_id}

فواتير المشتريات /api/purchase-invoice

سرد وإنشاء وتحديث وحذف وترحيل فواتير الشراء. (6 نقاط نهاية)

GET	/api/purchase-invoice
POST	/api/purchase-invoice/create
DELETE	/api/purchase-invoice/delete/{invoice_id}
POST	/api/purchase-invoice/post/{invoice_id}
GET	/api/purchase-invoice/show/{invoice_id}
POST	/api/purchase-invoice/update/{invoice_id}

مرتجعات الشراء /api/purchase-return

أنشئ مرتجعات الشراء ووافق عليها وأكملها. (6 نقاط نهاية)

GET	/api/purchase-return
POST	/api/purchase-return/approve/{return_id}
POST	/api/purchase-return/complete/{return_id}
POST	/api/purchase-return/create
DELETE	/api/purchase-return/delete/{return_id}
GET	/api/purchase-return/show/{return_id}

المحاسبة /api/chart-of-accounts

العملاء، الموردون، الحسابات البنكية، دليل الحسابات، الإيرادات، المصروفات، المدفوعات، إشعارات الدائن/المدين والتحويلات. (37 نقطة نهاية)

GET	/api/account-types
GET	/api/bank-accounts
POST	/api/bank-accounts/create
DELETE	/api/bank-accounts/delete/{id}
POST	/api/bank-accounts/update/{id}
GET	/api/bank-transactions
GET	/api/bank-transfers
GET	/api/chart-of-accounts
GET	/api/credit-notes
GET	/api/customer-payments
GET	/api/customers
POST	/api/customers/create
DELETE	/api/customers/delete/{id}
POST	/api/customers/update/{id}
GET	/api/debit-notes
GET	/api/expense-categories
GET	/api/expenses
POST	/api/expenses/approve/{id}
POST	/api/expenses/create
DELETE	/api/expenses/delete/{id}
POST	/api/expenses/post/{id}
POST	/api/expenses/update/{id}
GET	/api/get-clients
GET	/api/get-vendors
GET	/api/gl-accounts
GET	/api/revenue-categories
GET	/api/revenues
POST	/api/revenues/approve/{id}
POST	/api/revenues/create
DELETE	/api/revenues/delete/{id}
POST	/api/revenues/post/{id}
POST	/api/revenues/update/{id}
GET	/api/vendor-payments
GET	/api/vendors
POST	/api/vendors/create
DELETE	/api/vendors/delete/{id}
POST	/api/vendors/update/{id}

المنتجات والخدمات /api/products

المنتجات، والفئات، والضرائب، والوحدات، والمخزون. (20 نقطة نهاية)

GET	/api/product-service/items
POST	/api/product-stock/add
GET	/api/product-stocks
GET	/api/product/category
POST	/api/product/category/create
DELETE	/api/product/category/delete/{id}
POST	/api/product/category/update/{id}
POST	/api/product/create
DELETE	/api/product/delete/{id}
GET	/api/product/detail/{id}
POST	/api/product/update/{id}
GET	/api/products
GET	/api/tax
POST	/api/tax/create
DELETE	/api/tax/delete/{id}
POST	/api/tax/update/{id}
POST	/api/unit/create
DELETE	/api/unit/delete/{id}
POST	/api/unit/update/{id}
GET	/api/units

المستودع والمخزون /api/warehouse

المستودعات وتحويلات المخزون. (9 نقاط نهاية)

GET	/api/transfer
POST	/api/transfer/create
DELETE	/api/transfer/delete/{transfer_id}
GET	/api/transfer/request-data
GET	/api/warehouse
POST	/api/warehouse/create
DELETE	/api/warehouse/delete/{warehouse_id}
GET	/api/warehouse/product/{warehouse_id}
POST	/api/warehouse/update/{warehouse_id}

المشاريع والمهام والأخطاء /api/projects

المشاريع، والمعالم، ولوحات المهام، والمهام، والمهام الفرعية، والأخطاء، والتقارير. (45 نقطة نهاية)

GET	/api/bug-status-list
GET	/api/get-projects
POST	/api/project/bug-stage/create
DELETE	/api/project/bug-stage/delete/{id}
POST	/api/project/bug-stage/order
POST	/api/project/bug-stage/update/{id}
GET	/api/project/bug-stages
POST	/api/project/bug/create/{project_id}
GET	/api/project/bug/show/{bug_id}
POST	/api/project/bug/{bug_id}/comment/create
DELETE	/api/project/bug/{id}/comment/delete
GET	/api/project/bug/{project_id}
DELETE	/api/project/client/delete/{id}
POST	/api/project/client/invite
GET	/api/project/clients
DELETE	/api/project/delete/{id}
POST	/api/project/file/create
DELETE	/api/project/file/delete/{id}
DELETE	/api/project/member/delete/{id}
POST	/api/project/milestone/create
DELETE	/api/project/milestone/delete/{id}
POST	/api/project/milestone/update/{id}
GET	/api/project/milestones
GET	/api/project/report/{id}
GET	/api/project/reports
GET	/api/project/show/{id}
POST	/api/project/task-stage/create
DELETE	/api/project/task-stage/delete/{id}
POST	/api/project/task-stage/order
POST	/api/project/task-stage/update/{id}
GET	/api/project/task-stages
POST	/api/project/task-subtask/create/{task_id}
POST	/api/project/task-subtask/update/{subtask_id}
DELETE	/api/project/task/comment/delete/{comment_id}
GET	/api/project/task/show/{id}
POST	/api/project/task/{task_id}/comment/create
POST	/api/project/update/{id}
GET	/api/project/{id}/task-board
POST	/api/project/{id}/task/create
POST	/api/project/{id}/task/update/{task_id}
DELETE	/api/project/{project_id}/bug/delete/{bug_id}
POST	/api/project/{project_id}/bug/update/{bug_id}
DELETE	/api/project/{project_id}/task/delete/{task_id}
GET	/api/projects
POST	/api/projects/create

نقطة البيع /api/pos

طلبات نقاط البيع وتفاصيل الطلب. (2 نقاط النهاية)

GET	/api/pos
GET	/api/pos/show/{id}

مكتب الدعم /api/support-ticket/tickets

التذاكر والردود، الأسئلة الشائعة ومقالات قاعدة المعرفة. (16 نقطة نهاية)

POST	/api/support-ticket/faq/delete/{faq_id}
POST	/api/support-ticket/faq/update/{faq_id}
GET	/api/support-ticket/faqs
POST	/api/support-ticket/faqs/store
GET	/api/support-ticket/get-request-data
GET	/api/support-ticket/home
POST	/api/support-ticket/knowledge/delete/{knowledge_id}
POST	/api/support-ticket/knowledge/store
POST	/api/support-ticket/knowledge/update/{knowledge_id}
GET	/api/support-ticket/knowledges
POST	/api/support-ticket/ticket/add-reply/{ticket_id}
POST	/api/support-ticket/ticket/delete/{ticket_id}
POST	/api/support-ticket/ticket/note/store/{ticket_id}
POST	/api/support-ticket/ticket/store
POST	/api/support-ticket/ticket/update/{ticket_id}
GET	/api/support-ticket/tickets

Taskly /api/taskly/projects

مشاريع ومهام Taskly لوحدة المشاريع الخفيفة. (18 نقطة نهاية)

GET	/api/taskly/home
POST	/api/taskly/project-activity
POST	/api/taskly/project-create-update
POST	/api/taskly/project-delete
POST	/api/taskly/project-details
DELETE	/api/taskly/project-file-delete/{id}
POST	/api/taskly/project-file-upload
POST	/api/taskly/project-list
POST	/api/taskly/project-status-update
GET	/api/taskly/projects
GET	/api/taskly/projects/{project}/tasks
POST	/api/taskly/task-create-update
POST	/api/taskly/task-delete
POST	/api/taskly/task-details
POST	/api/taskly/task-list
POST	/api/taskly/task-stage-update
POST	/api/taskly/taskboard
GET	/api/taskly/users

تتبع الوقت /api/add-tracker

ابدأ وأوقف متتبعات الوقت. (3 نقاط نهاية)

POST	/api/add-tracker
POST	/api/stop-tracker
POST	/api/tracker-login

المستخدمون والأدوار /api/users

أدِر مستخدمي مساحة العمل واقرأ الأدوار. (8 نقاط نهاية)

GET	/api/roles
DELETE	/api/user/delete/{id}
POST	/api/user/reset-password/{id}
POST	/api/user/store
POST	/api/user/update/{id}
وضع	/api/user/verify/{id}
GET	/api/users
GET	/api/users/log

الموارد البشرية والرواتب /api/employees

الموظفون والحضور والإجازات وكشوف الرواتب، إضافة إلى مجموعة سجلات الموارد البشرية الكاملة (الفروع والأقسام والعطلات والجوائز والمزيد). (44 نقطة نهاية)

GET	/api/acknowledgments
GET	/api/announcements
POST	/api/attendance/create
DELETE	/api/attendance/delete/{attendance_id}
POST	/api/attendance/update/{attendance_id}
GET	/api/attendances
GET	/api/awards
GET	/api/branches
GET	/api/complaints
GET	/api/departments
GET	/api/designations
GET	/api/document-types
GET	/api/employee-transfers
POST	/api/employee/create
DELETE	/api/employee/delete/{id}
GET	/api/employee/show/{id}
POST	/api/employee/update/{id}
GET	/api/employees
GET	/api/events
GET	/api/holidays
GET	/api/hrm-documents
POST	/api/hrm/attendence-history
POST	/api/hrm/clock-in-out
POST	/api/hrm/events
GET	/api/hrm/get-leaves
GET	/api/hrm/get-leaves-types
GET	/api/hrm/holidays-list
GET	/api/hrm/home
POST	/api/hrm/leave-request
POST	/api/leave-application/create
DELETE	/api/leave-application/delete/{leaveapplication_id}
POST	/api/leave-application/update-status/{leaveapplication_id}
POST	/api/leave-application/update/{leaveapplication_id}
GET	/api/leave-applications
GET	/api/leave-balances
GET	/api/leave-types
GET	/api/payrolls
GET	/api/payrolls/{payroll_id}
GET	/api/payslip/{payroll_entry_id}
GET	/api/promotions
GET	/api/resignations
GET	/api/shifts
GET	/api/terminations
GET	/api/warnings

API خارجي (الإصدار 1) /api/v1/customers

شريحة ثابتة ذات إصدارات مبنية لأدوات عدم البرمجة مثل Zapier — العملاء والفواتير. (7 نقاط نهاية)

GET	/api/v1/customers
POST	/api/v1/customers
GET	/api/v1/customers/{id}
وضع	/api/v1/customers/{id}
GET	/api/v1/invoices
POST	/api/v1/invoices
GET	/api/v1/invoices/{id}

نقاط النهاية العامة /api/public/plans

مساعِدات غير موثّقة: كتالوج الخطط العام وأداة التقاط العملاء المحتملين القابلة للتضمين وشارة الشريك. (4 نقاط نهاية)

GET	/api/badge/{token}
GET	/api/public/plans
POST	/api/widget/lead
GET	/api/widget/{token}

منصة بعلامة بيضاء /api/wl/plans

نقاط نهاية من خادم إلى خادم تستخدمها مثيلات العلامة البيضاء للفوترة و Stripe Connect (مصادقة بالرمز المميز). (6 نقاط نهاية)

POST	/api/wl/checkout
POST	/api/wl/connect/onboard
GET	/api/wl/connect/status
GET	/api/wl/plans
POST	/api/wl/subscription/{stripe_subscription_id}/cancel
POST	/api/wl/webhook-callback

نقاط نهاية التكامل /api/microsofttodo

نقاط نهاية مساعدة للتكاملات المتصلة (Microsoft To Do، Vonage SMS، منشورات Facebook). (3 نقاط نهاية)

GET	/api/facebookpost
GET	/api/microsofttodo
GET	/api/vonagesms

نقاط نهاية أكثر

نقاط نهاية مسجّلة إضافية. (1 نقاط نهاية)

GET	/api/agents/{agent}/outstanding-commissions

مبني علىMewayz.