ربط نظامك مع أوديلا
كل اللي يحتاجه مبرمج المطعم عشان يحدّث المنيو والأسعار من نظامه. المفتاح ينشئه مالك المطعم من بوابة أوديلا.
كيف تربط نظامك
هالشرح لك ولمبرمجك. يمشي من أول مفتاح لين المزامنة اليومية، وتحته المرجع الكامل لكل نداء.
أنشئ مفتاح
من «مفاتيح الربط» في بوابة أوديلا. المفتاح يبان مرة وحدة، فانسخه واحفظه مع أسرار نظامك. ينرسل مع كل نداء في الترويسة Authorization. لا تحطه في صفحة ويب ولا في تطبيق جوال.
جرّب أول نداء
اقرا المنيو الحالي. إذا رجع الرد 200 فالمفتاح شغال والاتصال سليم.
cURLcurl -X GET "https://api.staging-odela.odel.sa/api/connect/v1/menu" \ -H "Authorization: Bearer $ODELA_API_KEY"أرسل الأقسام
كل قسم له رقم من نظامك (externalId) في آخر الرابط. إرسال نفس الرقم مرة ثانية يحدّث القسم وما يكرره.
cURLcurl -X PUT "https://api.staging-odela.odel.sa/api/connect/v1/menu/sections/sec-sandwiches" \ -H "Authorization: Bearer $ODELA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "nameAr": "السندويتشات", "nameEn": "Sandwiches" }'أرسل الأصناف
الصنف يحتاج قسمه واسمه بالعربي وسعره. التغيير يظهر في المنيو فورًا.
cURLcurl -X PUT "https://api.staging-odela.odel.sa/api/connect/v1/menu/items/sku-1042" \ -H "Authorization: Bearer $ODELA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "sectionExternalId": "sec-sandwiches", "nameAr": "شاورما دجاج", "nameEn": "Chicken shawarma", "priceHalalas": 900 }'السعر بالهللات
18.50 ريال تنكتب 1850. الرقم اللي فيه كسور ينرفض بخطأ invalid_price، وما ينقرّب أبد.
إذا المنيو موجود من قبل
لو رفع المطعم منيوه بالصور قبل الربط، الصنف اللي ترسله ياخذ مكان الموجود إذا كان في نفس القسم وبنفس الاسم العربي، فما يتكرر. وإذا الاسم مختلف، خذ رقم الصنف عندنا (id) من قراءة المنيو وأرسله مرة وحدة في odelaId.
خلال اليوم
خلص صنف؟ أرسل available بقيمة false، ولما يرجع أرسل true. تغيّر سعره؟ أرسل priceHalalas الجديد. هالنداء ما يلمس باقي بيانات الصنف.
cURLcurl -X PATCH "https://api.staging-odela.odel.sa/api/connect/v1/menu/items/sku-1042" \ -H "Authorization: Bearer $ODELA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "available": false }'المزامنة الكاملة
أرسل لين 500 صنف في نداء واحد. كل صنف ينحفظ لحاله: اللي يخالف قاعدة ينكتب سببه في الرد، والباقي ينحفظ.
الأخطاء والحدود
كل خطأ يرجع بنفس الشكل: كود ثابت تبرمج عليه، ورسالة، والحقل اللي فيه المشكلة. ولكل مفتاح عدد محدود من النداءات في الدقيقة: إذا تعداه يرجع 429 ومعه Retry-After بعدد الثواني اللي تنتظرها.
لازم تعرف
- اللي يرسله نظامك ينشر في المنيو فورًا، بدون مراجعة.
- كل تغيير يتسجّل باسم اللي أنشأ المفتاح.
- ما فيه حذف عن طريق الـ API. عشان توقف بيع صنف، خلّه غير متوفر.
- استقبال الطلبات في نظامك وتحديث حالتها ينضافون لنفس الـ API بعدين.
المرجع الكامل
كل نداء بحقوله وأمثلته وأخطائه. يتولّد من كود الـ API نفسه، فهو مطابق له دايم. نصوصه بالإنجليزي لأنها موجهة للمبرمج.