Odoo API इंटीग्रेशन गाइड: Odoo को किसी भी सिस्टम से कनेक्ट करें

ओडू शायद ही कभी अलगाव में काम करता है। व्यवसायों को इसे ईकॉमर्स प्लेटफ़ॉर्म, भुगतान प्रोसेसर, शिपिंग वाहक, मार्केटिंग टूल और कस्टम एप्लिकेशन से कनेक्ट करने की आवश्यकता होती है। ओडू एक्सटर्नल एपीआई दो प्रोटोकॉल प्रदान करता है - एक्सएमएल-आरपीसी और जेएसओएन-आरपीसी - जो किसी भी सिस्टम को ओडू में प्रोग्रामेटिक रूप से रिकॉर्ड पढ़ने, बनाने, अपडेट करने और हटाने में सक्षम बनाता है।

प्रमाणीकरण

एपीआई कुंजी प्रमाणीकरण

ओडू में एक एपीआई कुंजी उत्पन्न करें: अपने उपयोगकर्ता प्रोफ़ाइल पर नेविगेट करें, फिर खाता सुरक्षा, फिर एपीआई कुंजी। वर्णनात्मक लेबल के साथ एक कुंजी बनाएं. एपीआई प्रमाणीकरण के लिए अपने पासवर्ड के बजाय इस कुंजी का उपयोग करें - इसे आपके लॉगिन क्रेडेंशियल को बदले बिना स्वतंत्र रूप से रद्द किया जा सकता है।

कनेक्शन पैरामीटर

प्रत्येक एपीआई कॉल के लिए आवश्यक है: ओडू सर्वर यूआरएल, डेटाबेस नाम, आपका उपयोगकर्ता नाम (लॉगिन ईमेल), और एपीआई कुंजी। इन्हें सुरक्षित रूप से संग्रहीत करें - स्रोत कोड में कभी भी हार्डकोड क्रेडेंशियल न रखें।

एक्सएमएल-आरपीसी प्रोटोकॉल

कनेक्शन सेटअप

XML-RPC दो समापन बिंदुओं का उपयोग करता है: प्रमाणीकरण के लिए /xmlrpc/2/common और डेटा संचालन के लिए /xmlrpc/2/object। उपयोगकर्ता आईडी प्राप्त करने के लिए पहले प्रमाणित करें, फिर बाद की कॉल के लिए उस आईडी का उपयोग करें।

सीआरयूडी संचालन

खोजें और पढ़ें: डोमेन फ़िल्टर के साथ क्वेरी रिकॉर्ड (SQL WHERE क्लॉज के समान)। डोमेन टुपल्स का उपयोग करते हैं: [('state', '=', 'sale'), ('amount_total', '>', 1000)] को $1,000 से अधिक के पुष्ट बिक्री ऑर्डर मिलते हैं।

बनाएँ: फ़ील्ड मानों का एक शब्दकोश पास करें। एपीआई नई रिकॉर्ड आईडी लौटाता है। आवश्यक फ़ील्ड शामिल किए जाने चाहिए अन्यथा सत्यापन त्रुटि के साथ कॉल विफल हो जाएगी।

लिखें: रिकॉर्ड आईडी और परिवर्तित मानों का शब्दकोश पास करके मौजूदा रिकॉर्ड अपडेट करें। केवल वे फ़ील्ड शामिल करें जिन्हें आप संशोधित करना चाहते हैं।

अनलिंक: आईडी के आधार पर रिकॉर्ड हटाएं। सावधानी के साथ उपयोग करें - यदि कुछ रिकॉर्ड पर निर्भर रिकॉर्ड हैं तो उन्हें हटाया नहीं जा सकता।

JSON-RPC प्रोटोकॉल

JSON-RPC क्यों

JSON-RPC को आम तौर पर आधुनिक एकीकरणों के लिए पसंद किया जाता है: यह JSON (XML की तुलना में अधिक डेवलपर-अनुकूल) का उपयोग करता है, जावास्क्रिप्ट/टाइपस्क्रिप्ट अनुप्रयोगों के साथ बेहतर काम करता है, और बड़े पेलोड के लिए थोड़ा बेहतर प्रदर्शन प्रदान करता है।

अनुरोध प्रारूप

JSON-RPC कॉल एकल समापन बिंदु पर जाती हैं: /jsonrpc। प्रत्येक अनुरोध में मानक JSON-RPC 2.0 लिफाफे में सेवा का नाम, विधि और तर्क शामिल होते हैं।

सामान्य एकीकरण पैटर्न

ईकॉमर्स ऑर्डर सिंक

Shopify या WooCommerce से Odoo में ऑर्डर सिंक करें:

1. ईकॉमर्स प्लेटफॉर्म से ऑर्डर वेबहुक सुनें
2. ग्राहक डेटा को Odoo पार्टनर रिकॉर्ड में मैप करें (मौजूदा बनाएं या मिलान करें)
3. ओडू उत्पादों के लिए मैप किए गए लाइन आइटम के साथ एक बिक्री ऑर्डर बनाएं
4. पूर्ति वर्कफ़्लो को ट्रिगर करने के आदेश की पुष्टि करें
5. ट्रैकिंग जानकारी को वापस ईकॉमर्स प्लेटफॉर्म पर सिंक करें

भुगतान प्रोसेसर एकीकरण

स्ट्राइप, पेपाल या अन्य प्रोसेसर कनेक्ट करें:

1. भुगतान पुष्टिकरण वेबहुक प्राप्त करें
2. संदर्भ संख्या के आधार पर भुगतानों का Odoo चालान से मिलान करें
3. भुगतान को Odoo लेखांकन में पंजीकृत करें
4. बैंक विवरण के साथ स्वचालित रूप से मिलान करें

सीआरएम सिंक्रोनाइजेशन

Odoo CRM को बाहरी मार्केटिंग टूल के साथ समन्वयित रखें:

1. मार्केटिंग प्लेटफ़ॉर्म से नई लीड Odoo लीड बनाती हैं
2. लीड स्कोरिंग अपडेट द्विदिश रूप से प्रवाहित होते हैं
3. जीते गए अवसर मार्केटिंग टूल में अनुवर्ती अभियानों को ट्रिगर करते हैं
4. संपर्क जानकारी सभी प्रणालियों में समकालिक रहती है

त्रुटि प्रबंधन

सामान्य त्रुटियाँ

• प्रवेश निषेध: अमान्य क्रेडेंशियल या अपर्याप्त अनुमतियाँ
• सत्यापन त्रुटि: आवश्यक फ़ील्ड गुम या अमान्य मान
• रिकॉर्ड नहीं मिला: ऐसी आईडी का संदर्भ देना जो मौजूद नहीं है
• समवर्ती अद्यतन: किसी अन्य उपयोगकर्ता ने एक साथ रिकॉर्ड को संशोधित किया

सर्वोत्तम प्रथाएँ

1. क्षणिक विफलताओं के लिए घातीय बैकऑफ़ के साथ पुनः प्रयास तर्क लागू करें
2. त्रुटियों को शीघ्र पकड़ने के लिए भेजने से पहले डेटा सत्यापित करें
3. डिबगिंग और ऑडिट उद्देश्यों के लिए सभी एपीआई कॉल लॉग करें
4. संभाल दर सीमा - व्यक्तिगत कॉल के बजाय बैच संचालन
5. विफल कॉलों को सुरक्षित रूप से पुन: प्रयास करने के लिए इडेम्पोटेंट ऑपरेशंस का उपयोग करें

प्रदर्शन अनुकूलन

• बैच पढ़ता है: अलग-अलग search + read कॉल के बजाय search_read का उपयोग करें
• फ़ील्ड सीमित करें: केवल उन्हीं फ़ील्ड का अनुरोध करें जिनकी आपको आवश्यकता है, मॉडल पर सभी फ़ील्ड का नहीं
• पेगिनेशन: बड़े परिणाम सेट के लिए limit और offset का उपयोग करें
• कैशिंग: धीरे-धीरे बदलते डेटा (उत्पाद कैटलॉग, मुद्रा दरें) को स्थानीय स्तर पर कैश करें

वेबहुक पैटर्न

ओडू के सभी संस्करणों में देशी आउटबाउंड वेबहुक नहीं हैं। सामान्य दृष्टिकोण:

• स्वचालित क्रियाएं: सर्वर क्रियाएं जो रिकॉर्ड परिवर्तनों को ट्रिगर करती हैं और बाहरी यूआरएल को कॉल करती हैं
• कस्टम नियंत्रक: एक ओडू मॉड्यूल बनाएं जो बाहरी सिस्टम के लिए वेबहुक एंडपॉइंट्स को उजागर करता है
• मतदान: बाहरी प्रणालियाँ परिवर्तनों के लिए अंतराल पर ओडू पर मतदान करती हैं (सरल लेकिन कम वास्तविक समय)

सुरक्षा संबंधी विचार

• पासवर्ड के बजाय एपीआई कुंजियों का उपयोग करें
• नेटवर्क स्तर पर आईपी पते द्वारा एपीआई एक्सेस को प्रतिबंधित करें
• सभी एपीआई संचार के लिए HTTPS का उपयोग करें
• उचित पहुंच अधिकार लागू करें - एपीआई उपयोगकर्ताओं के पास न्यूनतम आवश्यक अनुमतियां होनी चाहिए
• एपीआई कुंजियों को नियमित रूप से घुमाएं और छेड़छाड़ की गई कुंजियों को तुरंत रद्द करें

हमारी Odoo एकीकरण सेवा उचित त्रुटि प्रबंधन, निगरानी और सुरक्षा के साथ उत्पादन-ग्रेड एकीकरण बनाती है।

अक्सर पूछे जाने वाले प्रश्न

मुझे किस प्रोटोकॉल का उपयोग करना चाहिए - XML-RPC या JSON-RPC?

नई परियोजनाओं के लिए JSON-RPC। यह अधिक डेवलपर-अनुकूल है, आधुनिक उपकरणों के साथ बेहतर काम करता है, और ओडू इसी दिशा में जा रहा है। पुराने सिस्टम या बेहतर XML-RPC लाइब्रेरी समर्थन वाली भाषाओं के लिए XML-RPC।

क्या कोई REST API है?

Odoo 17+ में RPC एंडपॉइंट के साथ एक REST API शामिल है। यह JSON पेलोड के साथ मानक REST सम्मेलनों का पालन करता है और आम तौर पर वेब अनुप्रयोगों के लिए इसके साथ काम करना आसान होता है।

मैं बड़े डेटा माइग्रेशन को कैसे संभालूं?

प्रारंभिक डेटा लोड के लिए, सीएसवी आयात सुविधा का उपयोग करें या एक माइग्रेशन स्क्रिप्ट लिखें जो प्रत्येक बैच के लिए त्रुटि प्रबंधन के साथ बैचों में रिकॉर्ड (प्रति बैच 100-500 रिकॉर्ड) बनाता है।

क्या मैं कस्टम एंडपॉइंट के साथ एपीआई का विस्तार कर सकता हूं?

हाँ। नियंत्रक वर्गों के साथ कस्टम ओडू मॉड्यूल बनाएं जो मानक एपीआई द्वारा कवर नहीं किए गए विशेष संचालन के लिए अतिरिक्त HTTP एंडपॉइंट्स को उजागर करते हैं।