العنوان الأساسي
| البيئة | العنوان |
|---|---|
| التجربة | https://sandbox.partners.aurmap.com/v1 (متاح الآن) |
| التشغيل | https://partners.aurmap.com/v1 (يفتح لكل مطور بعد اعتماده) |
عنوان التجربة يعمل الآن بمفاتيح التجربة. عنوان التشغيل يفتح لكل مطور بعد مراجعة تكامله واعتماده.
كل طلب موقع كما في المفاتيح والتوقيع. الأمثلة تستعمل دالة aurmap من البدء السريع.
المجموعات
| المجموعة | ماذا تفعل | الصلاحية | الحالة |
|---|---|---|---|
| الربط | رموز الربط، الروابط، إلغاء الربط | بلا صلاحية | متاح عند الإطلاق |
| الأماكن | قراءة المكان، إيقاف الطلبات مؤقتا | orders:write للتعديل |
متاح عند الإطلاق |
| الكتالوج | نشر القائمة كاملة وتعديلها، والنسخ | catalog:write |
القوائم متاحة. المنتجات قريبا |
| التوفر والمخزون | نفاد الأصناف، الأسعار المؤقتة، المخزون | inventory:write |
القوائم متاحة. المخزون بالعدد قريبا |
| الطلبات | استقبال الطلبات، القبول، الحالة، الإلغاء | orders:read، orders:write |
الاستلام من الفرع متاح. التوصيل قريبا |
| العروض | نشر العروض على الخريطة | offers:write |
قريبا |
| المحاسبة | المبيعات اليومية والتحويلات | accounting:read |
قريبا |
والأحداث التي نرسلها لك في الأحداث.
أعراف مشتركة
المعرفات
المعرفات نصوص لها بادئة: mer_ للتاجر، وplc_ للمكان، وlnk_ للربط، وord_ للطلب، وevt_ للحدث. تعامل معها كنص كامل، ولا تحاول تفكيكها.
معرفات الأصناف والأقسام والإضافات هي معرفاتك أنت. نحفظها كما هي ونعيدها لك في الطلبات. تكتب حتى 64 حرفا من [A-Za-z0-9_.-]، بلا نقطتين :.
الصلاحيات
كل نقطة نهاية تعلن صلاحيتها، وتجدها في جدول أعلى كل صفحة. نتحقق في كل طلب من المفتاح، ثم الحساب، ثم ربط المكان. وتضاف customer:contact لمن يحتاج رقم العميل كاملا.
المال
كل مبلغ عدد صحيح بالوحدة الصغرى (الهللة)، ومعه العملة. 2990 مع SAR تعني 29.90 ريال.
الوقت
كل وقت بتوقيت UTC بصيغة ISO 8601، مثل 2026-10-14T12:30:05Z. أوقات الدوام والأيام المحاسبية بالمنطقة الزمنية للمكان، وتجدها في place.timezone.
النصوص
النص خريطة لغات: { "ar": "برجر دجاج", "en": "Chicken burger" }. يكفي ar أو en، وتستطيع إضافة لغات أخرى.
القوائم والصفحات
{ "data": [ { "…": "…" } ], "next_cursor": "c_8Jk2" }أرسل cursor في الطلب التالي، وlimit من 1 إلى 100 (الافتراضي 50). إذا كان next_cursor فارغا فقد وصلت إلى النهاية.
الأخطاء
{ "error": { "code": "SCOPE_MISSING", "message": "This link has no orders:write scope.", "request_id": "req_01JA9Z", "details": { "scope": "orders:write" } } }كل الرموز في الأخطاء.
التوسع
داخل v1 نضيف فقط ولا نحذف. قد تظهر حقول جديدة وقيم جديدة وأنواع أحداث جديدة. تجاهل ما لا تعرفه. السياسة كاملة في سجل التغييرات.