API¶

Gem Logic API आपको बाहरी प्रणालियों के साथ एकीकृत करने और कार्यप्रवाह स्वचालित करने की सुविधा देता है। आप इसका उपयोग उत्पादों, बिक्री, संपर्कों, मरम्मत, सूची गणना और प्रिंट कार्यों को प्रोग्रामेटिक रूप से प्रबंधित करने के लिए कर सकते हैं।

अपनी API कुंजियाँ बनाने और प्रबंधित करने के लिए Settings ‣ API पर जाएं।

प्रमाणीकरण¶

सभी API अनुरोधों में x-api-key HTTP हेडर में एक API कुंजी शामिल होनी चाहिए। आप Settings ‣ API पृष्ठ से कुंजियाँ बना सकते हैं। कुंजियों को किसी भी समय निष्क्रिय या हटाया जा सकता है।

उदाहरण अनुरोध:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

खतरा

अपनी API कुंजियों को गुप्त रखें। उन्हें कभी भी सार्वजनिक रिपॉजिटरी या क्लाइंट-साइड कोड में साझा न करें। यदि कोई कुंजी समझौता हो जाती है, तो उसे तुरंत निष्क्रिय करें और एक नई बनाएं।

आधार URL¶

सभी एंडपॉइंट आपके इंस्टेंस URL के सापेक्ष हैं, /api/ उपसर्ग के अंतर्गत:

https://your-instance.gem-logic.com/api/

प्रतिक्रिया प्रारूप¶

सभी प्रतिक्रियाएं JSON के रूप में लौटाई जाती हैं। सफल अनुरोध 200 (GET के लिए) या 201 (POST के लिए) स्थिति कोड लौटाते हैं। त्रुटियाँ उपयुक्त स्थिति कोड के साथ एक संदेश लौटाती हैं:

200 OK — सफल GET अनुरोध
201 Created — सफल POST अनुरोध
400 Bad Request — अमान्य या लापता डेटा
401 Unauthorized — अमान्य या लापता API कुंजी
404 Not Found — संसाधन मौजूद नहीं है

एंडपॉइंट¶

मार्केटप्लेस¶

विधि	`GET`
URL	`/api/marketplaces/`
विवरण	सभी बिक्री चैनलों की सूची लौटाता है।

प्रतिक्रिया फ़ील्ड:

फ़ील्ड	Type	विवरण
`id`	integer	अद्वितीय पहचानकर्ता
`marketplace`	string	Marketplace नाम

उत्पाद¶

उत्पादों की सूची

विधि	`GET`
URL	`/api/products/{marketplace_id}`
विवरण	Marketplace के आधार पर फ़िल्टर किए गए उत्पाद लौटाता है। Marketplaces एंडपॉइंट से प्राप्त marketplace ID का उपयोग करें।

प्रतिक्रिया फ़ील्ड:

फ़ील्ड	Type	विवरण
`id`	integer	अद्वितीय पहचानकर्ता
`item_sku`	string	उत्पाद SKU
`created`	datetime	निर्माण तिथि
`status`	string	उत्पाद स्थिति
`images`	array	उत्पाद छवियों की सूची (`id`, `image`)
`item_weight`	decimal	वजन
`item_height`	decimal	ऊंचाई
`item_length`	decimal	लंबाई
`item_width`	decimal	चौड़ाई

उत्पाद छवि बनाएं

विधि	`POST`
URL	`/api/products/create/image/`
विवरण	base64 एन्कोडिंग का उपयोग करके उत्पाद छवि अपलोड करें। यदि उत्पाद SKU अभी तक मौजूद नहीं है, तो स्वचालित रूप से एक नया उत्पाद बनाया जाता है।

अनुरोध फ़ील्ड:

फ़ील्ड	Type	आवश्यक	विवरण
`item_sku`	string	हाँ	उत्पाद SKU जिससे छवि संलग्न करनी है
`image`	string (base64)	हाँ	Base64-एन्कोडेड छवि डेटा

बिक्री¶

बिक्री सूची

विधि	`GET`
URL	`/api/sales/`
विवरण	सभी बिक्री आदेशों की सूची लौटाता है।

प्रतिक्रिया फ़ील्ड:

फ़ील्ड	Type	विवरण
`order_id`	string	विशिष्ट आदेश पहचानकर्ता

बिक्री बनाएं

विधि	`POST`
URL	`/api/sales/create/`
विवरण	एक नया बिक्री आदेश बनाता है।

संपर्क¶

विधि	`GET`
URL	`/api/contacts/`
विवरण	सभी संपर्कों की सूची लौटाता है।

प्रतिक्रिया फ़ील्ड:

फ़ील्ड	Type	विवरण
`id`	integer	अद्वितीय पहचानकर्ता
`complete_name`	string	पूरा नाम
`contact_type`	string	संपर्क का प्रकार
`email`	string	ईमेल पता
`phone`	string	फ़ोन नंबर
`language`	string	पसंदीदा भाषा

मरम्मत¶

मरम्मत बनाएं

विधि	`POST`
URL	`/api/repairs/create/`
विवरण	एक संबद्ध मरम्मत वस्तु के साथ एक नया मरम्मत आदेश बनाता है। यदि बिक्री चैनल या प्रभाग प्रदान नहीं किया गया है, तो पहला उपलब्ध उपयोग किया जाता है।

अनुरोध फ़ील्ड:

फ़ील्ड	Type	आवश्यक	विवरण
`client_id`	integer	नहीं	ग्राहक/संपर्क की ID
`marketplace`	string / integer	नहीं	बिक्री चैनल ID या नाम
`division_id`	integer	नहीं	व्यावसायिक प्रभाग ID
`title`	string	नहीं	मरम्मत वस्तु का शीर्षक या विवरण
`repair_info_1`	string	नहीं	अतिरिक्त मरम्मत टिप्पणी
`repair_info_2`	string	नहीं	अतिरिक्त मरम्मत टिप्पणी
`repair_info_3`	string	नहीं	अतिरिक्त मरम्मत टिप्पणी
`quantity`	decimal	नहीं	मात्रा (डिफ़ॉल्ट: 1)
`weight`	decimal	नहीं	वस्तु का भार
`weight_unit`	string	नहीं	भार माप की इकाई
`size`	string	नहीं	वस्तु का आकार
`color`	string	नहीं	वस्तु का रंग
`engravement`	string	नहीं	उत्कीर्णन पाठ
`client_reference` \| string		नहीं	ग्राहक का संदर्भ नंबर

उदाहरण प्रतिक्रिया:

{"message": "Repair created successfully.", "order_id": "R-0001"}

मरम्मत में वस्तु जोड़ें

विधि	`POST`
URL	`/api/repairs/add-item/`
विवरण	मौजूदा मरम्मत आदेश में एक नई वस्तु जोड़ता है।

अनुरोध फ़ील्ड:

फ़ील्ड	Type	आवश्यक	विवरण
`order_id`	string	हाँ	मरम्मत का आदेश ID जिसमें वस्तु जोड़नी है
`item_sku`	string	नहीं	वस्तु से लिंक करने के लिए उत्पाद SKU
`title`	string	नहीं	शीर्षक या विवरण
`repair_info_1`	string	नहीं	अतिरिक्त मरम्मत टिप्पणी
`repair_info_2`	string	नहीं	अतिरिक्त मरम्मत टिप्पणी
`repair_info_3`	string	नहीं	अतिरिक्त मरम्मत टिप्पणी
`quantity`	decimal	नहीं	मात्रा (डिफ़ॉल्ट: 1)
`weight`	decimal	नहीं	वस्तु का भार
`weight_unit`	string	नहीं	भार माप की इकाई
`size`	string	नहीं	वस्तु का आकार
`color`	string	नहीं	वस्तु का रंग
`engravement`	string	नहीं	उत्कीर्णन पाठ
`client_reference` \| string		नहीं	ग्राहक का संदर्भ नंबर
`cost`	decimal	नहीं	वस्तु की लागत

सूची गणना¶

सूची गणना बनाएं

विधि	`POST`
URL	`/api/inventory-counts/`
विवरण	एक नया सूची गणना सत्र बनाता है।

प्रतिक्रिया फ़ील्ड:

फ़ील्ड	Type	विवरण
`id`	string	सूची गणना ID
`created_at`	datetime	निर्माण टाइमस्टैम्प
`status`	string	हमेशा `active`
`tag_count`	integer	गिनी गई वस्तुओं की संख्या

सूची गणना वस्तुओं की सूची बनाएं

विधि	`GET`
URL	`/api/inventory-counts/{inventory_count_id}/products/`
विवरण	किसी विशिष्ट सूची गणना में गिनी गई सभी वस्तुएं लौटाता है।

प्रतिक्रिया फ़ील्ड:

फ़ील्ड	Type	विवरण
`id`	string	अद्वितीय पहचानकर्ता
`created_at`	datetime	जब वस्तु गिनी गई थी
`product_sku`	string	उत्पाद SKU
`product_name`	string	उत्पाद का नाम
`quantity`	integer	गिनी गई मात्रा

प्रिंट कार्य¶

विधि	`POST`
URL	`/api/print-pdf/`
विवरण	किसी विशिष्ट प्रिंटर के लिए प्रिंट कतार में PDF फ़ाइल अपलोड करें। फ़ाइल को प्रारूप और सुरक्षा के लिए मान्य किया जाता है। अधिकतम फ़ाइल आकार 20 MB है। `multipart/form-data` सामग्री प्रकार का उपयोग करें।

अनुरोध फ़ील्ड:

फ़ील्ड	Type	आवश्यक	विवरण
`pdf`	फ़ाइल	हाँ	प्रिंट करने के लिए PDF फ़ाइल (अधिकतम 20 MB)
`printer_uuid`	UUID	हाँ	लक्षित प्रिंटर का UUID
`landscape`	boolean	नहीं	लैंडस्केप मोड में प्रिंट करें (डिफ़ॉल्ट: false)

उदाहरण अनुरोध:

curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -F "pdf=@document.pdf" \
  -F "printer_uuid=YOUR_PRINTER_UUID"

उदाहरण प्रतिक्रिया:

{"status": "queued", "print_job_id": 42}

इंटरैक्टिव API एक्सप्लोरर¶

Gem Logic में Swagger UI द्वारा संचालित एक अंतर्निहित इंटरैक्टिव API एक्सप्लोरर शामिल है। आप सेटिंग ‣ API पृष्ठ पर API प्रलेखन लिंक से इसे एक्सेस कर सकते हैं। एक्सप्लोरर आपको अपने ब्राउज़र से सीधे प्रत्येक एंडपॉइंट को आज़माने देता है।

यह भी देखिए

एकीकरण