المصادقة والحدود

احصل على مفتاح API من قسم عمليات التكامل (Integrations).

الإمكانات

• إدارة الفواتير: الإنشاء، والإلغاء، والتحقق من الحالة
• إدارة الدفعات: قوائم الدفعات، وربط الدفعة بالفاتورة
• الإحصاءات: بيانات مجمَّعة حسب المشروع والفترة والمحفظة وغيرها
• الفوترة: تعرفات المشاريع والأرصدة

الحدود

• معدل الطلبات: طلب واحد في الثانية لكل مفتاح كحد أقصى
• عدد المفاتيح: 10 لكل حساب

تفويض الطلبات

مرّر مفتاح API في الترويسة Authorization لتفويض كل طلب إلى API.

مثال على الترويسة Authorization في طلب API:

curl -X POST https://api.bitsby.app/invoices/list \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay"

استجابة الخادم

يستجيب خادم API دائمًا بصيغة JSON. استخدم المعطى result لمعرفة ما إذا كان الطلب قد نجح.

مثال على استجابة لطلب ناجح:

{
    "result": "success",
    "data": .....
}

مثال على استجابة لخطأ:

{
    "result": "error",
    "data": "Requests too frequent"
}