انتقل إلى المحتوى
تجربة مجانية 14 يومًا، بلا بطاقة9 لغات176 نوع عمل · 50 تطبيقًا
AR· USD
جرّب عرضًا حيًاابدأ التجربة المجانية

مفاتيح API والنطاقات

ما يمكن للمفتاح قراءته وكتابته، والحدود التي يحملها من الشخص الذي أنشأه.

Authorization: Bearer fx_live_…

قواعد يتبعها كل مفتاح

  • يُعرض المفتاح مرة واحدة؛ ولا يُخزَّن إلا تجزئة SHA-256 الخاصة به
  • لا يغطي المفتاح إلا المجالات التي يستطيع منشئه فتحها؛ ومفتاح كل المجالات لمالك مساحة العمل فقط
  • يعمل المفتاح داخل فروع منشئه وشركاته، مثل الشخص في المكتب الخلفي؛ والسجلات التي ينشئها تذهب إلى فرع ذلك الشخص
  • عند تعطيل المنشئ أو حذفه يتوقف المفتاح عن العمل
  • يمكن أن تنتهي صلاحية المفاتيح ويمكن إلغاؤها في أي وقت؛ وكل طلب مسجل في سجل الطلبات

التعرّف على المفتاح

يبدأ كل مفتاح بـ fx_live_. تعرض قائمة المفاتيح أول 14 حرفًا منه، لتميّز المفاتيح دون رؤية المفتاح كاملًا.

إذا تسرّب مفتاح

  1. ألغِه فورًا من الإدارة ← التكاملات والواجهة البرمجية؛ يتوقف مع الطلب التالي
  2. أنشئ مفتاحًا جديدًا بالنطاقات نفسها وحدّث أنظمتك
  3. راجع سجل الطلبات بحثًا عن استدعاءات لا تعرفها
  4. إذا كان المفتاح يملك الكتابة، فراجع السجلات التي أنشأها

المرجع أدناه باللغة الإنجليزية، مثل مستند OpenAPI.

النطاقات

customers:readList and read customers
customers:writeCreate customers and update their contact details
quotations:readList and read quotations (with items)
quotations:writeCreate draft quotations
invoices:readList and read invoices (with items and payments)
invoices:writeCreate draft invoices
orders:readList and read shop orders
inquiries:readList and read leads
inquiries:writeCreate leads (goes through the same notifications as the website form)
products:readList and read products with stock
webhooks:readRead the webhook event catalog and delivery log
payments:readList and read invoice payments
stock:readRead stock locations and stock levels
stock:writeAdd or remove stock (adjustments, write-offs)
appointments:readList and read appointments
pos:readList and read till sales and refunds
tasks:readList and read tasks
tasks:writeCreate tasks and change them (status, due date, priority)
attachments:writeUpload photos and PDFs (optionally onto a task)
sensors:writeUpload readings of sensor devices (temperature, humidity, fuel level) — Sensors & cold chain
catalog:readRead the catalog: products, product categories, services and bookable services
bookings:readRead appointments and free time slots
bookings:writeBook appointments (same checks as online booking)
webhooks:writeList, create and delete webhook endpoints

التالي: مساحة عمل تجريبية

جرّب الواجهة على مساحة عمل تجريبية شخصية ببيانات نموذجية. لا يصل أي شيء تفعله هناك إلى العالم الخارجي.

مساحة عمل تجريبية