مواد پر جائیں
14 دن کا مفت ٹرائل، کارڈ کی ضرورت نہیں9 زبانیں176 کاروباری اقسام · 50 ایپس
UR· USD
لائیو ڈیمو آزمائیںمفت آزمائش شروع کریں

API کلیدیں اور اسکوپس

ایک کلید کیا پڑھ اور لکھ سکتی ہے، اور اسے بنانے والے شخص سے کون سی حدود ملتی ہیں۔

Authorization: Bearer fx_live_…

وہ اصول جن پر ہر کلید چلتی ہے

  • کلید ایک بار دکھائی جاتی ہے؛ صرف اس کا SHA-256 ہیش محفوظ ہوتا ہے
  • کلید صرف وہ حصے احاطہ کر سکتی ہے جو اس کا بنانے والا کھول سکتا ہے؛ تمام حصوں والی کلید صرف ورک اسپیس کے مالک کے لیے ہے
  • کلید اپنے بنانے والے کی شاخوں اور کمپنیوں کے اندر کام کرتی ہے، بیک آفس میں اس شخص کی طرح؛ اس کے بنائے ریکارڈ اسی شخص کی شاخ میں جاتے ہیں
  • بنانے والے کو غیر فعال یا حذف کرنے پر کلید کام کرنا بند کر دیتی ہے
  • کلیدوں کی میعاد ختم ہو سکتی ہے اور انہیں کسی بھی وقت منسوخ کیا جا سکتا ہے؛ ہر درخواست درخواستوں کے لاگ میں ہے

کلید پہچاننا

ہر کلید fx_live_ سے شروع ہوتی ہے۔ کیز کی فہرست اس کے پہلے 14 حروف دکھاتی ہے، تاکہ پوری کلید دیکھے بغیر کیز الگ پہچانی جا سکیں۔

اگر کوئی کلید لیک ہو جائے

  1. اسے فوراً Admin → Integrations & API میں منسوخ کریں؛ اگلی درخواست سے یہ کام نہیں کرے گی
  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

اگلا: سینڈ باکس ورک اسپیس

نمونہ ڈیٹا والی ذاتی ڈیمو ورک اسپیس پر API آزمائیں۔ وہاں آپ جو بھی کریں باہر کی دنیا تک نہیں پہنچتا۔

سینڈ باکس ورک اسپیس