المصادقة

تُصادَق كل طلبات Integration API باستخدام مفتاح API يُرسَل في ترويسة X-Api-Key. لا توجد بيانات اعتماد أخرى لإدارتها — لا تدفّق OAuth ولا رموز بحاجة إلى تجديد.

إنشاء مفتاح API

تُنشأ مفاتيح API داخل المنصة، وليس عبر الواجهة.

إرسال المفتاح

أضِف المفتاح إلى ترويسة X-Api-Key في كل طلب:

curl https://integration.fatorly.com/v1/invoices \
  -H "X-Api-Key: fat_your_key_here" \
  -H "Content-Type: application/json"

يؤدّي المفتاح المفقود أو غير الصالح إلى 401 Unauthorized؛ أما المفتاح الصالح الذي لا يملك الصلاحية التي تتطلّبها نقطة النهاية فيؤدّي إلى 403 Forbidden — راجع الأخطاء.

نطاق المفتاح وأمانه

• شركة واحدة لكل مفتاح. يقتصر نطاق كل مفتاح على شركة/مستأجر واحد. للتكامل مع عدّة شركات، أنشئ مفتاحًا لكل شركة.
• أقل صلاحية ممكنة. امنح فقط النطاقات التي يستخدمها التكامل.
• تعامل معه كأنه كلمة مرور. احفظ المفاتيح في مدير أسرار، ولا تضعها أبدًا في نظام التحكّم بالمصدر أو في كود يعمل على جهة العميل.

التالي

• البدء السريع — أنشئ أول فاتورة لك.
• معرّف عدم التكرار — اجعل عمليات الكتابة آمنة لإعادة المحاولة.