شريك. دخول للحساب

API شريك

اربط أنظمتك الداخلية أو تطبيقاتك بشريك مباشرة — اسحب بيانات عملائك وعقودك، أنشئ فواتير، واستقبل تنبيهات فورية بالـwebhooks.

المصادقة رموز الأخطاء GET /clients GET /contracts GET /contracts/:id/statement POST /invoices GET /consolidated-trial-balance GET /forecast/cash-flow Webhooks

المصادقة

كل طلب لازم يحمل توكن Bearer في الـheader. تقدر تولّد توكن من إعدادات حسابك (Tokens API) بعد ما تسجّل دخول.

Authorization: Bearer YOUR_API_TOKEN

كل توكن بيتحدد له صلاحية أو أكتر (abilities) وقت إنشائه — الـendpoint بيرفض أي توكن مالوش الصلاحية المطلوبة.

الصلاحيةبتسمح بإيه
readقراءة العملاء، العقود، كشوف الحساب، ميزان المراجعة، توقع التدفق النقدي
write-invoicesإنشاء فواتير مسودة (لسه محتاجة مراجعة وترحيل يدوي من الشاشة العادية)
manage-webhooksإدارة اشتراكات الـwebhook (عرض/إضافة/حذف)

حد أقصى 60 طلب في الدقيقة لكل توكن.

رموز الأخطاء

الحالةالمعنى
401توكن مفقود، غلط، منتهي، أو حساب صاحب التوكن معطّل
402اشتراك الشركة منتهي
403التوكن مالوش الصلاحية المطلوبة، أو الموديول ده مش مفعّل للشركة
404السجل مش موجود، أو تابع لشركة تانية
422بيانات الطلب غير صحيحة
429تجاوزت حد الطلبات (60/دقيقة)

الـEndpoints

GET/api/v1/clients
readinstallments

قائمة عملاء شركتك، مقسّمة صفحات (حد أقصى 100 في الصفحة).

curl https://app.sharikadvisory.com/api/v1/clients \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    { "id": 1, "name": "أحمد محمد", "phone": "99887766", "email": null, "created_at": "2026-07-01T10:00:00Z" }
  ],
  "current_page": 1,
  "per_page": 50
}
GET/api/v1/contracts
readinstallments

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

curl https://app.sharikadvisory.com/api/v1/contracts \
  -H "Authorization: Bearer YOUR_API_TOKEN"
GET/api/v1/contracts/{id}/statement
readinstallments

كشف حساب تفصيلي لعقد معيّن.

POST/api/v1/invoices
write-invoicesaccounting

إنشاء فاتورة عامة كـ"مسودة" — لسه محتاجة مراجعة وترحيل يدوي من شاشة الفواتير العادية، مش بترحّل تلقائي.

curl -X POST https://app.sharikadvisory.com/api/v1/invoices \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 1,
    "invoice_date": "2026-08-21",
    "payment_type": "credit",
    "lines": [
      { "account_id": 12, "description": "استشارة", "quantity": 1, "unit_price": 150.00 }
    ]
  }'
GET/api/v1/consolidated-trial-balance
readaccounting

ميزان مراجعة موحّد لمجموعة شركاتك (لو شركتك عضو في مجموعة).

GET/api/v1/forecast/cash-flow?months=6
readaccounting

توقع التدفق النقدي لعدد شهور قادمة (افتراضيًا 6).

Webhooks

سجّل رابط عندك عشان يستقبل تنبيه فوري (HTTPS فقط) أول ما حدث معيّن يحصل عندك.

GET/api/v1/webhooks/subscriptions
manage-webhooks
POST/api/v1/webhooks/subscriptions
manage-webhooks
curl -X POST https://app.sharikadvisory.com/api/v1/webhooks/subscriptions \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/hook", "event": "payment.created" }'
DELETE/api/v1/webhooks/subscriptions/{id}
manage-webhooks

الأحداث المتاحة

eventبيتطلق لما
payment.createdعند تسجيل دفعة جديدة
invoice.postedعند ترحيل فاتورة عامة
vendor_bill.postedعند ترحيل فاتورة مورد
credit_note.postedعند ترحيل مذكرة دائن
debit_note.postedعند ترحيل مذكرة مدين
vendor_payment.createdعند تسجيل سداد لمورد
invoice_payment.createdعند تسجيل سداد فاتورة عامة
contract.createdعند إنشاء عقد تقسيط جديد
quotation.acceptedعند قبول عميل لعرض سعر عن طريق رابط العميل
quotation.rejectedعند رفض عميل لعرض سعر عن طريق رابط العميل
purchase_order.confirmedعند تأكيد مورد لأمر شراء عن طريق رابط المورد
purchase_order.declinedعند رفض مورد لأمر شراء عن طريق رابط المورد

كل طلب webhook بيتوقّع بـHMAC-SHA256 باستخدام السر (secret) اللي بترجعه وقت التسجيل — تأكد من التوقيع قبل ما تثق في المحتوى.