مفاتيح API والنطاقات
ما يمكن للمفتاح قراءته وكتابته، والحدود التي يحملها من الشخص الذي أنشأه.
Authorization: Bearer fx_live_…
قواعد يتبعها كل مفتاح
- يُعرض المفتاح مرة واحدة؛ ولا يُخزَّن إلا تجزئة SHA-256 الخاصة به
- لا يغطي المفتاح إلا المجالات التي يستطيع منشئه فتحها؛ ومفتاح كل المجالات لمالك مساحة العمل فقط
- يعمل المفتاح داخل فروع منشئه وشركاته، مثل الشخص في المكتب الخلفي؛ والسجلات التي ينشئها تذهب إلى فرع ذلك الشخص
- عند تعطيل المنشئ أو حذفه يتوقف المفتاح عن العمل
- يمكن أن تنتهي صلاحية المفاتيح ويمكن إلغاؤها في أي وقت؛ وكل طلب مسجل في سجل الطلبات
التعرّف على المفتاح
يبدأ كل مفتاح بـ fx_live_. تعرض قائمة المفاتيح أول 14 حرفًا منه، لتميّز المفاتيح دون رؤية المفتاح كاملًا.
إذا تسرّب مفتاح
- ألغِه فورًا من الإدارة ← التكاملات والواجهة البرمجية؛ يتوقف مع الطلب التالي
- أنشئ مفتاحًا جديدًا بالنطاقات نفسها وحدّث أنظمتك
- راجع سجل الطلبات بحثًا عن استدعاءات لا تعرفها
- إذا كان المفتاح يملك الكتابة، فراجع السجلات التي أنشأها
المرجع أدناه باللغة الإنجليزية، مثل مستند OpenAPI.
النطاقات
customers:read | List and read customers |
customers:write | Create customers and update their contact details |
quotations:read | List and read quotations (with items) |
quotations:write | Create draft quotations |
invoices:read | List and read invoices (with items and payments) |
invoices:write | Create draft invoices |
orders:read | List and read shop orders |
inquiries:read | List and read leads |
inquiries:write | Create leads (goes through the same notifications as the website form) |
products:read | List and read products with stock |
webhooks:read | Read the webhook event catalog and delivery log |
payments:read | List and read invoice payments |
stock:read | Read stock locations and stock levels |
stock:write | Add or remove stock (adjustments, write-offs) |
appointments:read | List and read appointments |
pos:read | List and read till sales and refunds |
tasks:read | List and read tasks |
tasks:write | Create tasks and change them (status, due date, priority) |
attachments:write | Upload photos and PDFs (optionally onto a task) |
sensors:write | Upload readings of sensor devices (temperature, humidity, fuel level) — Sensors & cold chain |
catalog:read | Read the catalog: products, product categories, services and bookable services |
bookings:read | Read appointments and free time slots |
bookings:write | Book appointments (same checks as online booking) |
webhooks:write | List, create and delete webhook endpoints |
التالي: مساحة عمل تجريبية
جرّب الواجهة على مساحة عمل تجريبية شخصية ببيانات نموذجية. لا يصل أي شيء تفعله هناك إلى العالم الخارجي.