REST API

ابنِ تكاملات قوية.

واجهة REST بصيغة JSON ومُدارة بالإصدارات، محمية بمصادقة لكل مفتاح. اشترك في خطافات الويب لـ 12 حدثًا تشمل المهام والفواتير والمدفوعات وعروض الأسعار والعملاء. متاحة في باقة Scale.

مصادقة لكل مفتاح REST بنظام إصدارات · v1 12 حدث خطاف ويب 5 نطاقات ضريبية
bash · إنشاء مهمة عبر REST API
curl https://api.servicesynchq.com/api/v1/jobs \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": 12345,
    "scheduledDate": "2026-08-20T14:00:00Z",
    "title": "HVAC repair"
  }'
json · الاستجابة · يُبثّ الآن
201 Created
{  "id": 84213,  "customerId": 12345,  "status": "scheduled",  "scheduledDate": "2026-08-20T14:00:00Z",  "title": "HVAC repair",  "createdAt": "2026-07-24T08:14:22Z"}
REST API · v1
مستقر، بإصدارات، JSON
X-API-Key
مصادقة لكل مفتاح
عمليات CRUD كاملة
عبر جميع بياناتك
12 حدثًا
Webhooks في الوقت الفعلي
مرجع API

نقاط النهاية الرئيسية

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

REST · /api/v1

عمليات CRUD كاملة عبر JSON، مؤمَّنة بواسطة X-API-Key.

/customers/jobs/estimates /invoices/payments/inventory
خطافات الويب · 12 حدثًا

سجّل نقطة نهاية وتفاعل في الوقت الفعلي.

job.createdinvoice.paidpayment.received estimate.acceptedcustomer.created

طريقتان للتكامل — REST للقراءة والكتابة، وwebhooks للدفع الفوري في الوقت الفعلي.

200 OK GET

/api/v1/customers

عرض قائمة بجميع العملاء.

ترقيم صفحات بالمؤشر (cursor)
201 Created POST

/api/v1/customers

أنشئ عميلًا جديدًا.

يدعم idempotency-key
200 OK GET

/api/v1/jobs

اعرض المهام مُرشَّحة حسب الحالة أو التاريخ.

قابل للفرز والتصفية
201 Created POST

/api/v1/jobs

جدولة مهمة جديدة. تُطلق job.created خطاف الويب.

مُسجَّل في سجل التدقيق
200 OK GET

/api/v1/invoices

عرض الفواتير مع الترقيم الصفحي.

مُدرِك للاختصاص الضريبي
202 Accepted POST

/api/v1/invoices/:id/send

أرسل الفاتورة عبر البريد الإلكتروني أو SMS. يُنشَأ IRN تلقائيًا للهند.

مدعوم بطابور إعادة المحاولة

عيّنة تمثيلية تشمل العملاء · المهام · عروض الأسعار · الفواتير · المدفوعات · المخزون · المشتريات · الجدولة · الإشعارات. كل استدعاء ذي صلاحية يُسجَّل في سجل التدقيق. اطّلع على المرجع الكامل ←

الامتثال العالمي · C7

5 اختصاصات ضريبية، وواجهة API واحدة

مرّر رمز الدولة لتحصل على الحسابات الضريبية الصحيحة، وتخطيط المستند الصحيح، وحمولة الفاتورة الإلكترونية الصحيحة. نفس نقاط النهاية، وسلوك يراعي النطاق الضريبي — دون أي تفرُّعات خاصة بكل دولة في كود التكامل الخاص بك.

ضريبة GST في الهندضريبة المبيعات الأمريكيةVAT المملكة المتحدةضريبة VAT في الاتحاد الأوروبيVAT دول الخليج
IN الهندCGST + SGST داخل الولاية · IGST بين الولايات · فاتورة IRN الإلكترونية (نافذة إلغاء 24 ساعة) · رموز HSN
UK المملكة المتحدةاستقطاع CIS بنسبة 20% / 30% / 0% (يُخصم تلقائيًا حسب حالة التسجيل) · إقرارات VAT
EU الاتحاد الأوروبي (SDI XML)صيغة الفاتورة الإلكترونية الإيطالية SDI XML · توجيه VAT عبر الحدود · الاحتساب العكسي (reverse-charge)
SA المملكة العربية السعودية (المرحلة 1 من ZATCA)ثنائي اللغة عربي/إنجليزي · رمز TLV QR مع 5 علامات إلزامية · VAT 15%
AE الإمارات / دول مجلس التعاون الخليجيVAT 5% · دعم الفاتورة العربية · حقول امتثال FTA
CA كنداتوجيه GST · HST · PST · QST حسب المقاطعة · فواتير جاهزة لـ CRA
AU أسترالياGST بنسبة 10% · استقطاع ABN بنسبة 49% (للموردين بدون ABN)
US الولايات المتحدةتوجيه ضريبة مبيعات الولاية · الوجهة/المنشأ · معالجة شهادات إعادة البيع
محرك الضرائب

حسابات الامتثال، مؤتمتة بالكامل

مرّر النية فقط — ونحن نحسب التفصيل الضريبي الصحيح. تغييرات الولاية، وتغييرات التسجيل، ومفاتيح النطاق الضريبي كلها بيانات وليست كودًا. عزل بمستوى مصرفي: بيانات كل عميل تعيش في خزينتها المنطقية الخاصة — وقاعدة البيانات نفسها ترفض خلط البيانات بين الخزائن، وليس كود التطبيق فقط.

التوجيه داخل الولاية مقابل بين الولايات

هل ولاية المورّد نفسها ولاية العميل؟ CGST + SGST. مختلفة؟ IGST. تُحتسب من company.state مقابل customer.state.

الفاتورة الإلكترونية IRN لضريبة GST الهندية

يُنشئ IRN + رمز QR موقَّعًا عند POST. 24h cancellation window متاح عبر نقطة نهاية مخصّصة. أكواد HSN عبر البحث.

خصم CIS في المملكة المتحدة

يُخصم تلقائيًا 20% / 30% / 0% بناءً على حالة تسجيل المقاول، لكل مقاول من الباطن.

TLV QR لـ ZATCA (السعودية)

فاتورة ثنائية اللغة للمرحلة الأولى + ترميز TLV QR لجميع 5 mandatory tags. يتم التحقق منها لدى ZATCA قبل العرض.

المصادقة

المصادقة والأمان

يتم توثيق كل طلب بمفتاح API يُرسَل في X-API-Key الترويسة. تُنشئ المفاتيح بواسطة مسؤولي مستأجرك، ويمكن إبطالها في أي وقت، ويُسجَّل كل استدعاء ذي صلاحية في سجل التدقيق.

مفتاح API ••••••••

تظهر المفاتيح مرة واحدة عند الإنشاء وتُخزَّن على شكل تجزئة (hash) فقط — ولا تُحفظ أبدًا كنص صريح.

  • المصادقة بمفتاح API أرسل مفتاحك السري في X-API-Key الترويسة في كل طلب.
  • يُنشئه ويلغيه مسؤولوك أنشئ المفاتيح وألغِها ضمن الإعدادات → مفاتيح API. يسري إلغاء أي مفتاح فوراً.
  • مُجزَّأة أثناء التخزين يُخزَّن فقط تجزئة (hash) غير قابلة للعكس لكل مفتاح — ويُعرض المفتاح الخام مرة واحدة فقط عند الإنشاء.
  • سجل تدقيق لكل عملية ذات صلاحية مَن، ومتى، ومن أين، وما الذي تغيَّر — سجل مقاوم للتلاعب ومرئي لمسؤولي مستأجرك.
  • متاح في باقة Scale الوصول البرمجي عبر API مُضمَّن في باقة Scale.
bash · مصادقة طلب
curl https://api.servicesynchq.com/api/v1/customers \
  -H "X-API-Key: YOUR_API_KEY"

# 200 OK — returns your customers as JSON.
# Manage keys under Settings → API keys (admin only).
Webhooks · 12 حدثًا

تفاعل مع كل حدث في الوقت الفعلي

اشترك في أحداث دورة الحياة عبر CRM والإرسال والفوترة والمدفوعات والمشتريات والتدقيق. كل خطاف ويب موقَّع تشفيريًا، ويُعاد إرساله بتراجع أُسّي، ومدعوم بطابور إعادة محاولة دائم.

job.created

تم إنشاء مهمة جديدة.

job.completed

تم وضع علامة اكتمال على المهمة.

job.status_changed

انتقلت مهمة إلى حالة جديدة.

invoice.created

تم إنشاء فاتورة جديدة.

invoice.paid

تم استلام دفعة الفاتورة.

invoice.overdue

تجاوزت الفاتورة تاريخ استحقاقها دون سداد.

payment.received

تم تسجيل دفعة من العميل.

customer.created

تمت إضافة عميل جديد.

estimate.sent

أُرسل عرض السعر إلى العميل.

estimate.accepted

قبِل العميل عرض السعر.

estimate.rejected

رفض العميل عرض السعر.

estimate.converted_to_job

تحوّل عرض السعر المقبول إلى مهمة.

SDKs

مكتبات العميل — على خارطة الطريق

حِزم SDK الرسمية قيد التطوير. وإلى حين إطلاقها، فإن واجهة REST API موثَّقة بالكامل أعلاه وتعمل مع أي عميل HTTP.

Node.js

قريبًا

Python

قريبًا

PHP

قريبًا

Ruby

قريبًا
العزل

عزل المستأجرين، مفروض على مستوى قاعدة البيانات

يُقيَّد كل طلب تلقائيًا ضمن نطاق مساحة عملك على مستوى طبقة قاعدة البيانات — وليس في كود التطبيق فحسب. لا يمكن حرفياً لاستعلام من مساحة عمل أن يقرأ بيانات مساحة عمل أخرى — قاعدة البيانات نفسها تفرض ذلك.

  • ✓ العزل مفروض على مستوى قاعدة البيانات
  • ✓ تم التحقق منه عبر مجموعة اختبارات عزل آلية
  • ✓ محاولات الربط بين المستأجرين تُرجع نتيجة فارغة، لا خطأ أبداً
  • ✓ انتحال هوية المشرف الأعلى مُسجَّل في سجل التدقيق
Business C Fully isolated Business B Fully isolated Business A Fully isolated POSTGRES · ROW-LEVEL SECURITY POLICIES
حدود المعدل

سخيّة وشفّافة، والترويسات تُطلعك

حدود استخدام عادلة مع سعة اندفاعية. يُعاد إرسال حدّك الحالي وحصتك المتبقية مع كل استجابة في X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset الترويسات (مسودة معيار IETF). لن تحتاج أبدًا إلى التخمين بشأن المسموح به.

قياسي

Solo · Essentials · Growth

مضمَّنة في كل باقة تتيح الوصول إلى API.

قيم افتراضية سخية

مساحة كافية للتكاملات الاعتيادية · الترويسات تُطلعك على ذلك في الوقت الفعلي

للمؤسسات

باقة Scale + إضافة Enterprise

حدود مخصَّصة، وسعة مُخصَّصة، واتفاقيات مستوى خدمة (SLA).

مخصّص

تواصل مع المبيعات لتحديد الحجم المناسب

عند بلوغك حدًا: ستتلقى استجابة HTTP 429 Too Many Requests مع Retry-After رأسًا في غضون ثوانٍ. تتعامل حزم SDK الخاصة بنا مع هذا تلقائيًا عبر التراجع الأُسّي. وإذا كنت بحاجة بانتظام إلى سقوف أعلى، تحدّث إلينا — فالأرقام المنشورة هي حدود دنيا، لا حدود قصوى.
الأمان

مفاتيح API الخاصة بك، نتعامل معها كما تستحق الأسرار

نحمي مفاتيحك تمامًا كما نحبّ أن تُحمى مفاتيحنا. إليك ما يمكنك الاعتماد عليه.

TLS فقط، في كل مكان

كل طلب إلى الـ API مُشفَّر أثناء النقل باستخدام TLS الحديث. ويُرفض HTTP العادي عند الحافة.

مُقيَّد بنطاق المستأجر حسب التصميم

كل مفتاح API مرتبط بمساحة عمل واحدة. لا يوجد أي مسار يتيح لمفتاح من مساحة العمل A قراءة بيانات مساحة العمل B — وهذا مفروض على مستوى طبقة قاعدة البيانات، وليس التطبيق فقط.

سجل تدقيق لكل استدعاء ذي صلاحية

مَن، ومتى، ومن أين، وما الذي تغيَّر. سجل مقاوم للتلاعب وقابل للقراءة من قِبل المستأجر. مثالي لمراجعات الامتثال. اقرأ المزيد في صفحة الأمان.

إبطال فوري للمفاتيح

تشكّ في تسرّب؟ ألغِ المفتاح من لوحة الإدارة ليتوقف عن العمل فورًا. أصدر مفتاحًا جديدًا وحدّث تكاملك.

مُجزّأ أثناء التخزين

لا يُخزَّن سوى تجزئة (hash) غير قابلة للعكس لكل مفتاح. أما المفتاح الخام فيُعرض مرة واحدة عند الإنشاء، ولا يُحفظ أبدًا كنص صريح.

سجل تدقيق لكل استدعاء

تُسجَّل كل عملية API ذات صلاحية — مَن، ومتى، ومن أين، وما الذي تغيّر — في سجلّ مقاوم للعبث يمكن لمسؤوليك مراجعته.

أفضل الممارسات لحماية مفاتيح API الخاصة بك

لا تُودِع المفاتيح في git أبدًا استخدم متغيرات البيئة أو مدير أسرار. وإذا سرّبت مفتاحاً، فبدّله من لوحة الإدارة قبل دفع الإصلاح.
استدعِ الـ API من الخادم الخلفي لديك احتفظ بالمفاتيح على جانب الخادم — ولا تكشفها أبدًا في متصفح أو تطبيق جوال.
بدّل المفاتيح كل ربع سنة أو في أي وقت يغادر فيه فريقك شخصٌ لديه صلاحية الوصول إلى المفاتيح.
مفتاح واحد لكل تكامل مفتاح منفصل لكل تكامل يعني أنه يمكنك إلغاء مفتاح واحد فقط إذا تسرّب.
خزِّن المفاتيح في مدير أسرار (secrets manager) متغيرات البيئة أو خزنة أسرار — وليس نظام التحكم بالمصدر، ولا مستندًا مشتركًا.
راقب سجل التدقيق ظهور عنوان IP غير مألوف يستخدم مفتاحك إشارةٌ تستحق التحقيق.

جاهز للبناء؟

الوصول إلى API مُضمَّن في باقة Scale. اقرأ الوثائق أولاً، واحصل على مفاتيحك عندما تكون جاهزاً.