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

إنشاء مفتاح API

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

افتح مفاتيح API

في التطبيق، انتقل إلى الإعدادات ← التكاملات ← مفاتيح API (/settings/integration/api-keys). راجع مفاتيح API للاطّلاع على مرجع الإعدادات الكامل.
2

سمِّ المفتاح وحدّد نطاقاته

امنح المفتاح اسمًا وصفيًا واختر فقط النطاقات التي يحتاجها التكامل (مثل invoices:write).
3

انسخ السرّ

اختر Create API Key. يُعرض السرّ — الذي يبدو بالشكل fat_…مرة واحدة فقط. انسخه فورًا واحفظه بأمان؛ لن تتمكّن من رؤيته مجددًا.

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

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

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

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

التالي