وصول الـ API
اربط نظام نقاط البيع أو ERP أو متجرك الإلكتروني مباشرة ببيانات نقاطي — بدون وسيط، بدون انتظار.
نظرة عامة
تتيح واجهة برمجة التطبيقات في نقاطي لأنظمتك الخاصة — جهاز نقاط البيع، ERP مثل Odoo، متجر Shopify/WooCommerce، أو برمجيات مخصصة — قراءة وكتابة بيانات الولاء الخاصة بك مباشرة، بدلاً من عمل موظفيك داخل تطبيق نقاطي. تسجيل العملاء، التحقق من الأرصدة، منح النقاط، واستبدال المكافآت يمكن أن يحدث تلقائياً من أي مكان تحدث فيه مبيعاتك بالفعل.
تغطي هذه الصفحة الشاشة داخل التطبيق حيث يمكنك تفعيل وإدارة وصول الـ API: إنشاء المفاتيح، مراقبة الاستخدام، ومراقبة التكاملات. للحصول على المرجع الكامل للنقاط النهائية، تفاصيل المصادقة، ونماذج التعليمات البرمجية، راجع مرجع واجهة برمجة التطبيقات في نقاطي.
وصول الـ API متضمن فقط مع خطة الأعمال — غير متاح بأي سعر في خطة الاحترافية. داخل حسابك، فقط المالك يمكنه عرض أو إدارة مفاتيح الـ API؛ الموظفون لا يرون هذه الشاشة أبداً، بغض النظر عن صلاحياتهم.
تفعيل الوصول للـ API
إذا كان حسابك على خطة الأعمال، يتم فتح وصول الـ API تلقائياً — افتح الإعدادات > وصول الـ API للبدء. إذا لم تكن بعد على خطة الأعمال، تعرض الشاشة نفسها ما يقدمه الـ API مع زر "تواصل معنا للتفعيل"، الذي يصل فريقنا عبر تواصل مع الدعم.
إنشاء مفتاح API
- على شاشة وصول الـ API، اضغط "مفتاح جديد"
- أعطه تسمية تصف أين سيتم استخدامه، مثال "نقاط البيع الفرع الرئيسي"
- حدد النطاقات — الصلاحيات المحددة التي يجب أن يمتلكها هذا المفتاح — أو استخدم الإعدادات المسبقة "الكل" أو "قراءة فقط"
- أكد لإنشاء المفتاح
يتم عرض السر الكامل مرة واحدة بالضبط، بعد الإنشاء مباشرة. انسخه إلى تكوين نظامك فوراً؛ نقاطي يخزن ويعرض فقط نسخة مقنعة (مثل nq_live_ab12…wxyz) بعد ذلك.
يمكنك الاحتفاظ بـ 10 مفاتيح نشطة كحد أقصى لكل حساب — ما يكفي لإعطاء كل فرع، جهاز نقاط البيع، أو تكامل مفتاحه الخاص بنطاقاته الخاصة.
النطاقات المتاحة
| النطاق | يسمح بـ |
|---|---|
customers:read | عرض بيانات العملاء وأرصدة النقاط |
customers:write | تسجيل عملاء جدد |
transactions:read | عرض تاريخ النقاط والمكافآـت |
transactions:write | إضافة النقاط واستبدال المكافآت |
cards:read | عرض بطاقات الولاء وتكوين المكافآت |
webhooks:manage | إنشاء وإدارة اشتراكات webhook |
امنح المفتاح فقط النطاقات التي يحتاجها فعلياً. جهاز نقاط البيع الذي يختتم النقاط فقط، على سبيل المثال، يحتاج transactions:write و customers:read — ليس webhooks:manage.
تدوير وإلغاء المفاتيح
افتح ورقة التفاصيل لأي مفتاح لرؤية نطاقاته، حد المعدل، تاريخ الإنشاء، ووقت آخر استخدام، بالإضافة إلى إجراءين:
- تدوير: يصدر سراً جديداً لنفس المفتاح. السر القديم يستمر في العمل لـ فترة سماح 24 ساعة حتى تتمكن من تحديث أنظمتك بدون توقف.
- إلغاء: يُعطل المفتاح فوراً ودائماً. لا يمكن التراجع عن هذا — استخدمه عندما يكون المفتاح مهدداً أو لم يعد مطلوباً.
مراقبة الاستخدام
تعرض شاشة وصول الـ API ملخصاً متداولاً لمدة 30 يوماً: إجمالي الطلبات، معدل النجاح، متوسط وقت الاستجابة، وكم عدد الطلبات التي تم تحديدها بمعدل. يعرض موجز نشاط منفصل أحدث استدعاءات الـ API الخاصة بك مع طريقة HTTP ونقطة النهاية وكود الحالة، حتى تتمكن من اكتشاف تكامل فاشل بسرعة.
التكاملات و Webhooks
تعطيك شاشة التكاملات (مرتبطة من وصول الـ API) عرض مراقبة لكيفية ربط أنظمتك:
- المنصات المتصلة: حالة لـ Foodics و Odoo و Shopify و WooCommerce أو تكامل مخصص، مع وقت آخر مزامنة
- نقاط نهاية webhook: URL لكل نقطة نهاية، الأحداث المشتركة، الحالة، ومحاولات التسليم الأخيرة
- النشاط الأخير: أحدث طلبات الـ API الخاصة بك عبر جميع المفاتيح
هذه الشاشة للمراقبة فقط — يتم تسجيل نقاط نهاية webhook نفسها عبر الـ API باستخدام نطاق webhooks:manage. راجع مرجع الـ API لتفاصيل نقطة النهاية.
أحداث webhook المتاحة: transaction.created، points.awarded، reward.redeemed، customer.created، customer.updated، card.created، card.updated، و test.ping للتحقق من نقطة نهاية جديدة.
الخطوة التالية
جاهز للبدء في البناء؟ انتقل إلى مرجع الـ API الكامل للحصول على نقاط النهاية وتفاصيل المصادقة، أو راجع ماذا تفتحه خطة الأعمال أيضاً.