सीधे कंटेंट पर जाएँ
14 दिन का मुफ़्त ट्रायल, कार्ड नहीं चाहिए9 भाषाएँ176 व्यवसाय प्रकार · 50 ऐप
HI· 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 आज़माएँ। वहाँ आप जो भी करें, बाहर की दुनिया तक नहीं पहुँचता।

सैंडबॉक्स वर्कस्पेस