Odoo API انٹیگریشن گائیڈ: Odoo کو کسی بھی سسٹم سے مربوط کریں۔

اوڈو شاذ و نادر ہی تنہائی میں کام کرتا ہے۔ کاروباروں کو اسے ای کامرس پلیٹ فارمز، ادائیگی کے پروسیسرز، شپنگ کیریئرز، مارکیٹنگ ٹولز، اور کسٹم ایپلی کیشنز سے منسلک کرنے کی ضرورت ہے۔ Odoo External API دو پروٹوکول فراہم کرتا ہے — XML-RPC اور JSON-RPC — جو کسی بھی سسٹم کو Odoo میں پروگرام کے لحاظ سے ریکارڈ کو پڑھنے، تخلیق کرنے، اپ ڈیٹ کرنے اور حذف کرنے کے قابل بناتا ہے۔

توثیق

API کلیدی توثیق

Odoo میں ایک API کلید بنائیں: اپنے صارف پروفائل، پھر اکاؤنٹ سیکیورٹی، پھر API کیز پر جائیں۔ وضاحتی لیبل کے ساتھ ایک کلید بنائیں۔ API کی توثیق کے لیے اپنے پاس ورڈ کی بجائے اس کلید کا استعمال کریں — اسے آپ کے لاگ ان کی اسناد کو تبدیل کیے بغیر آزادانہ طور پر منسوخ کیا جا سکتا ہے۔

کنکشن کے پیرامیٹرز

ہر API کال کی ضرورت ہوتی ہے: Odoo سرور URL، ڈیٹا بیس کا نام، آپ کا صارف نام (لاگ ان ای میل)، اور API کلید۔ ان کو محفوظ طریقے سے اسٹور کریں — کبھی بھی ہارڈ کوڈ اسناد کو سورس کوڈ میں نہ رکھیں۔

XML-RPC پروٹوکول

کنکشن سیٹ اپ

XML-RPC دو اختتامی نکات استعمال کرتا ہے: /xmlrpc/2/common تصدیق کے لیے اور /xmlrpc/2/object ڈیٹا آپریشنز کے لیے۔ Authenticate first to get a user ID, then use that ID for subsequent calls.

CRUD آپریشنز

تلاش اور پڑھیں: ڈومین فلٹرز کے ساتھ استفسار ریکارڈز (SQL WHERE شقوں کی طرح)۔ ڈومینز ٹیپلز کا استعمال کرتے ہیں: [('state', '=', 'sale'), ('amount_total', '>', 1000)] کو $1,000 سے زیادہ کے تصدیق شدہ سیلز آرڈر ملتے ہیں۔

تخلیق کریں: فیلڈ ویلیوز کی ایک ڈکشنری پاس کریں۔ API نیا ریکارڈ ID واپس کرتا ہے۔ مطلوبہ فیلڈز کو شامل کرنا ضروری ہے یا کال توثیق کی خرابی کے ساتھ ناکام ہوجاتی ہے۔

لکھیں: ریکارڈ IDs اور تبدیل شدہ اقدار کی لغت پاس کرکے موجودہ ریکارڈز کو اپ ڈیٹ کریں۔ صرف وہ فیلڈز شامل کریں جن میں آپ ترمیم کرنا چاہتے ہیں۔

ان لنک: ID کے ذریعے ریکارڈز کو حذف کریں۔ احتیاط کے ساتھ استعمال کریں — کچھ ریکارڈز کو حذف نہیں کیا جا سکتا اگر ان میں منحصر ریکارڈ ہوں۔

JSON-RPC پروٹوکول

کیوں JSON-RPC

JSON-RPC کو عام طور پر جدید انضمام کے لیے ترجیح دی جاتی ہے: یہ JSON (XML سے زیادہ ڈویلپر دوستانہ) استعمال کرتا ہے، JavaScript/TypeScript ایپلی کیشنز کے ساتھ بہتر کام کرتا ہے، اور بڑے پے لوڈز کے لیے قدرے بہتر کارکردگی پیش کرتا ہے۔

درخواست کی شکل

JSON-RPC کالز ایک ہی اختتامی نقطہ پر جاتی ہیں: /jsonrpc۔ ہر درخواست میں ایک معیاری JSON-RPC 2.0 لفافے میں سروس کا نام، طریقہ، اور دلائل شامل ہوتے ہیں۔

مشترکہ انضمام کے پیٹرن

ای کامرس آرڈر کی مطابقت پذیری۔

Shopify یا WooCommerce سے Odoo سے آرڈرز کی مطابقت پذیری کریں:

1. ای کامرس پلیٹ فارم سے ویب ہکس آرڈر کرنے کے لیے سنیں۔
2. Odoo پارٹنر کے ریکارڈ پر کسٹمر ڈیٹا کا نقشہ بنائیں (موجودہ بنائیں یا میچ کریں)
3. Odoo پروڈکٹس میں میپ کیے گئے لائن آئٹمز کے ساتھ سیل آرڈر بنائیں
4. تکمیلی ورک فلو کو متحرک کرنے کے لیے آرڈر کی تصدیق کریں۔
5. ٹریکنگ کی معلومات کو دوبارہ ای کامرس پلیٹ فارم پر سنک کریں۔

ادائیگی کے پروسیسر کا انضمام

پٹی، پے پال، یا دوسرے پروسیسرز کو جوڑیں:

1. ادائیگی کی تصدیق کے ویب ہکس وصول کریں۔
2. حوالہ نمبر کے ذریعہ ادائیگیوں کو Odoo انوائسز سے میچ کریں۔
3. Odoo اکاؤنٹنگ میں ادائیگی کو رجسٹر کریں۔
4. بینک سٹیٹمنٹس کے ساتھ خود بخود مفاہمت کریں۔

CRM ہم وقت سازی

Odoo CRM کو بیرونی مارکیٹنگ ٹولز کے ساتھ مطابقت پذیر رکھیں:

1. مارکیٹنگ پلیٹ فارمز سے نئی لیڈز Odoo لیڈز تخلیق کرتی ہیں۔
2. لیڈ اسکورنگ اپ ڈیٹس دو طرفہ بہاؤ
3. جیتنے والے مواقع مارکیٹنگ ٹول میں فالو اپ مہمات کو متحرک کرتے ہیں۔
4. رابطہ کی معلومات تمام سسٹمز میں مطابقت پذیر رہتی ہے۔

ہینڈلنگ کی خرابی۔

عام غلطیاں

• رسائی سے انکار کر دیا گیا: غلط اسناد یا ناکافی اجازتیں۔
• توثیق کی خرابی: مطلوبہ فیلڈز غائب یا غلط اقدار
• ریکارڈ نہیں ملا: ایسی شناخت کا حوالہ دینا جو موجود نہیں ہے۔
• ایک ساتھ تازہ کاری: ایک اور صارف نے بیک وقت ریکارڈ میں ترمیم کی۔

بہترین طرز عمل

1. عارضی ناکامیوں کے لیے ایکسپونینشل بیک آف کے ساتھ **دوبارہ کوشش کی منطق کو نافذ کریں۔
2. غلطیوں کو جلد پکڑنے کے لیے ** بھیجنے سے پہلے ڈیٹا کی توثیق کریں۔
3. ڈیبگنگ اور آڈٹ کے مقاصد کے لیے **تمام API کالز کو لاگ کریں۔
4. ریٹ کی حد کو ہینڈل کریں — انفرادی کالوں کے بجائے بیچ آپریشنز
5. ناکام کالوں کو محفوظ طریقے سے دوبارہ آزمانے کے لیے **آدمی آپریشنز کا استعمال کریں۔

کارکردگی کی اصلاح

• بیچ پڑھتا ہے: علیحدہ search + read کالوں کے بجائے search_read استعمال کریں
• فیلڈز کو محدود کریں: صرف ان فیلڈز کی درخواست کریں جن کی آپ کو ضرورت ہے، ماڈل پر موجود تمام فیلڈز کی نہیں۔
• صفحہ بندی: بڑے رزلٹ سیٹ کے لیے limit اور offset استعمال کریں
• کیچنگ: مقامی طور پر آہستہ آہستہ تبدیل ہونے والے ڈیٹا (پروڈکٹ کیٹلاگ، کرنسی کی شرح) کیش

ویب ہک پیٹرنز

Odoo کے تمام ورژنز میں مقامی آؤٹ باؤنڈ ویب ہکس نہیں ہیں۔ عام نقطہ نظر:

• خودکار کارروائیاں: سرور کی کارروائیاں جو ریکارڈ کی تبدیلیوں کو متحرک کرتی ہیں اور بیرونی یو آر ایل کو کال کرتی ہیں
• کسٹم کنٹرولرز: ایک Odoo ماڈیول بنائیں جو بیرونی سسٹمز کے لیے ویب ہک اینڈ پوائنٹس کو بے نقاب کرے۔
• پولنگ: بیرونی نظام تبدیلیوں کے لیے وقفوں پر اوڈو پول کرتے ہیں (سادہ لیکن کم حقیقی وقت)

سیکیورٹی کے تحفظات

• پاس ورڈز کے بجائے **API کیز کا استعمال کریں۔
• نیٹ ورک کی سطح پر IP ایڈریس کے ذریعہ ** API رسائی کو محدود کریں۔
• تمام API مواصلات کے لیے HTTPS استعمال کریں۔
• درست رسائی کے حقوق کو نافذ کریں — API صارفین کو کم از کم ضروری اجازتیں ہونی چاہئیں
• API کیز کو باقاعدگی سے گھمائیں اور سمجھوتہ شدہ کلیدوں کو فوری طور پر منسوخ کریں۔

ہماری Odoo انٹیگریشن سروس مناسب خرابی سے نمٹنے، نگرانی اور سیکورٹی کے ساتھ پروڈکشن گریڈ انٹیگریشن بناتی ہے۔

اکثر پوچھے گئے سوالات

مجھے کون سا پروٹوکول استعمال کرنا چاہیے — XML-RPC یا JSON-RPC؟

نئے منصوبوں کے لیے JSON-RPC۔ یہ زیادہ ڈویلپر کے لیے دوستانہ ہے، جدید ٹولز کے ساتھ بہتر کام کرتا ہے، اور Odoo جس سمت جا رہا ہے۔ XML-RPC لیگیسی سسٹمز یا زبانوں کے لیے بہتر XML-RPC لائبریری سپورٹ کے ساتھ۔

کیا کوئی REST API ہے؟

Odoo 17+ میں RPC اینڈ پوائنٹس کے ساتھ REST API شامل ہے۔ یہ JSON پے لوڈز کے ساتھ معیاری REST کنونشنز کی پیروی کرتا ہے اور عام طور پر ویب ایپلیکیشنز کے ساتھ کام کرنا آسان ہے۔

میں بڑے ڈیٹا کی منتقلی کو کیسے ہینڈل کروں؟

ابتدائی ڈیٹا لوڈ کرنے کے لیے، CSV امپورٹ فیچر استعمال کریں یا ایک مائیگریشن اسکرپٹ لکھیں جو ہر بیچ کے لیے خرابی سے نمٹنے کے ساتھ بیچز (100-500 ریکارڈز فی بیچ) میں ریکارڈ بنائے۔

کیا میں کسٹم اینڈ پوائنٹس کے ساتھ API کو بڑھا سکتا ہوں؟

جی ہاں کنٹرولر کلاسز کے ساتھ حسب ضرورت Odoo ماڈیولز بنائیں جو معیاری API میں شامل خصوصی آپریشنز کے لیے اضافی HTTP اینڈ پوائنٹس کو بے نقاب کرتے ہیں۔