البناء على SolaBill API
Integrate invoice and credit note submission, monitor processing lifecycle, and automate ERP sync with secure multi-tenant client APIs and webhook events.
خريطة التوثيق
ابدء
الإعداد خطوة بخطوة بدءًا من المصادقة وحتى إرسال الفاتورة الأولى.
مرجع واجهة برمجة التطبيقات
Endpoint catalog, schemas, request/response examples, and status codes.
إشعارات الويب
بيانات الأحداث، والتحقق من التوقيع، وآلية إعادة المحاولة، وإرشادات المستهلك.
بيئة الاختبار
بيئة آمنة للتكامل لاختبار المسارات السعيدة والمسارات الفاشلة قبل بدء التشغيل.
أدوات تطوير البرامج (SDKs).
عملاء اللغة ومقتطفات البدء السريع لـ PHP وNode.js وPython.
سجل التغيير
ملاحظات الإصدار وتغييرات الإصدار وإرشادات التوافق.
تدفق التكامل
| خطوة | فعل | الإخراج |
|---|---|---|
| 1 | تسجيل الدخول عبر POST /api/v1/client/auth/login | رمز وصول Bearer |
| 2 | Submit invoice/credit note payload | المستند الذي تم إنشاؤه + معرف التتبع |
| 3 | مراقبة مع نقطة نهاية حالة الرسالة | حالة المعالجة الحالية |
| 4 | التعامل مع أحداث النداء الراجع لإشعار الويب | التحولات الدولة في الوقت الحقيقي تقريبا |
| 5 | أعد محاولة العناصر الفاشلة مع البيانات المصححة | تم استرداد خط أنابيب التسليم |
أساسيات المصادقة
Every request must include an active client token and stay within authorized tenant/client boundaries. Unauthorized or cross-tenant access attempts are denied.
| منطقة | قاعدة | أولوية |
|---|---|---|
| استخدام الرمز المميز | يشمل Authorization: Bearer <token> في كل استدعاء نقطة النهاية المحمية. | شديد الأهمية |
| التحكم في النطاق | لا تقم أبدًا بإعادة استخدام الرموز المميزة عبر حسابات العملاء أو المستأجرين. | شديد الأهمية |
| تناوب | قم بتدوير بيانات الاعتماد بشكل دوري وقم بإلغاء الرموز المميزة المخترقة على الفور. | عالي |
أفضل ممارسات التكامل
- استخدم مفاتيح التكرار الآمن أو معرّفات مستندات أعمال فريدة عند تنفيذ عمليات إعادة المحاولة.
- تحقق من صحة بيانات الطلب في جهة العميل قبل الإرسال لتقليل تكرار استجابات 422.
- تنفيذ التراجع الأسي على الأخطاء العابرة مثل 429 و500 و503.
- احفظ أحداث إشعارات الويب وتعامل مع التكرارات بأمان.
- نفّذ اختبارات الانحدار في بيئة الاختبار قبل اعتماد تغييرات التكامل للإصدار.