SolaBill API الشروع في العمل

Integrate your ERP or billing system in a few steps: authenticate, submit invoice payloads, monitor processing status, and receive events through webhooks.

واجهة برمجة التطبيقات v1 مصادقة الرمز المميز تم تمكين إعادات محاولة إشعارات الويب

المتطلبات الأساسية

قبل الاتصال بواجهات برمجة تطبيقات الإنتاج، تأكد من اكتمال إعداد حساب العميل الخاص بك.

متطلباتوصفحالة
بيانات اعتماد مستخدم العميلActive email/password for API loginمطلوب
معرف مشارك بيبولالهوية المسجلة لتبادل المستندات الصادرةمطلوب
نقطة نهاية إشعار الويبنقطة نهاية HTTPS عامة لاستقبال النداءات الراجعةمُستَحسَن
التحقق في بيئة الاختبارقم بإجراء اختبار شامل في وضع الحماية أولاًمُستَحسَن

المصادقة

احصل على رمز الوصول وقم بتمريره في Authorization: Bearer <token> header.

curl -X POST "https://solabill.com/api/v1/client/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "client.user@example.com",
    "password": "password",
    "device_name": "erp-connector"
  }'
{
  "success": true,
  "message": "Login successful",
  "data": {
    "token": "1|sample-token-value",
    "token_type": "Bearer"
  }
}

إرسال الفاتورة

أنشئ فاتورة باستخدام رمز Bearer الخاص بك. احتفظ بـ رقم الفاتورة unique per client account.

curl -X POST "https://solabill.com/api/v1/client/invoices" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "invoice_number": "INV-2026-1001",
    "recipient_name": "Acme LLC",
    "recipient_peppol_id": "ae:TRN123456789000003",
    "issue_date": "2026-02-12",
    "due_date": "2026-03-12",
    "currency": "AED",
    "total_amount": 1500.00
  }'

التحقق

يتم التحقق من صحة بيانات الطلب قبل الحفظ. تعيد الحقول غير الصالحة استجابة HTTP 422 مع رسائل على مستوى الحقل.

معالجة قائمة الانتظار

بعد الإنشاء، يتم تشغيل معالجة الرسائل في قائمة انتظار الخلفية لتحديثات النقل والحالة.

استراتيجية العجز

استخدم معرفات الفاتورة الفريدة عند إعادة المحاولة لتجنب السجلات المالية المكررة.

حالة المسار

استخدم نقاط نهاية التتبع لمراقبة حالات دورة الحياة من القبول إلى التسليم.

curl -X GET "https://solabill.com/api/v1/client/messages/{trackingId}" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
حالةمعنىفعل
مقبولتم قبول الطلب ووضعه في قائمة الانتظارانتظر الحدث القادم
processingDocument under validation/transportالاستطلاع أو انتظار إشعار الويب
تم التوصيلتم التسليم بنجاحوضع علامة مكتملة في ERP
فشلفشل التسليم أو التحقق من الصحةافحص الخطأ وأعد محاولة التدفق

تدفق إشعارات الويب

اشترك في الأحداث لتجنب الاقتراع المتكرر واحصل على تحديثات في الوقت الفعلي تقريبًا.

  1. أنشئ اشتراك إشعار ويب من حساب العميل الخاص بك.
  2. تحقق من التواقيع في طلبات النداء الراجع الواردة.
  3. قم بإرجاع HTTP 2xx بسرعة وقم بالمعالجة بشكل غير متزامن في نظامك.
  4. التعامل مع عمليات إعادة المحاولة لعمليات التسليم المكررة بأمان.

الأخطاء وإعادة المحاولة

رمز HTTPيكتبإرشادات التعامل
400اقتراح غير جيدأصلح بنية بيانات الطلب وأعد المحاولة بعد التصحيح.
401غير مصرح بهقم بتحديث رمز تسجيل الدخول ثم أعد المحاولة.
403مُحرَّمالتحقق من أذونات الحساب ونطاق المستأجر.
422خطأ في التحققفحص الأخطاء الميدانية وتصحيح تعيين المصدر.
429معدل محدودتطبيق التراجع الأسي والارتعاش.
500/503Server/transientأعد المحاولة مع التراجع؛ تنبيه إذا تكررت.
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "invoice_number": ["The invoice number field is required."]
  }
}

اذهب إلى قائمة التحقق المباشرة