تخطَّ إلى المحتوى

مرجع المطورين

هذه الصفحة مرجع الحقول لشاشة المطورون في وضع المكتب الخلفي بتطبيق نقطة البيع، وهي ما يفتحه زر مساعدة أعلى الشاشة. لخطوات العمل اليومي راجع عملاء الواجهة في قسم المطورين.

الغرض من الشاشة: هنا تُدار عملاء الواجهة البرمجية لمنشأتك: تنشئ العميل ويظهر سرّه مرة واحدة، وتعدّل اسمه وصلاحياته وفروعه، وتدوّر سرّه، وتلغي مفتاح سر واحدًا، وتلغي العميل نهائيًا. تعرض الشاشة أيضًا اشتراكات الويبهوك وترسل إليها حدثًا اختباريًا. لا يوجد حذف. يمكن إدارة العملاء أيضًا من صفحة الواجهة البرمجية العامة في لوحة معلومات التاجر. يفتح القسمَ من يملك صلاحية إدارة عملاء الواجهة. القفل هنا لكل قدرة: تبقى الصفحة مقروءة بلا ميزة الواجهة في الخطة وتُقفل الكتابة وحدها.

إنشاء عميل

الحقلالمعنى
عميل واجهة جديدالإجراء الرئيسي أعلى الشاشة. يفتح نافذة فيها اسم العميل (من ٣ إلى ١٦٠ حرفًا)، والصلاحيات، ونطاق الفروع. يُقفل بلا ميزة الواجهة في الخطة.
الصلاحياتبطاقة لكل صلاحية تقبلها أيدي، باسمها ورمزها ووصف سطر واحد لما تفتحه، ومفتاح الخطة الإضافي إن احتاجته: صلاحيات العملاء تحتاج crm، وقراءة المخزون تحتاج inventory.advanced، والتحليلات ضمن قراءة التقارير تحتاج analytics.basic. صلاحيات التجهيز وإدارة الويبهوك مقبولة ولا تستخدمها أي عملية عامة بعد. اختر صلاحية واحدة على الأقل.
نطاق الفروع«كل الفروع» يصل إلى كل فرع، ومنها ما يُضاف لاحقًا. اختر فروعًا بعينها لتقييد العميل بها. إن تعذرت قراءة قائمة الفروع لا يُتاح إلا «كل الفروع».
انسخ السر الآنتظهر بعد الإنشاء أو التدوير، ولا تُغلق بالنقر خارجها. تعرض معرّف العميل ومعرّف المفتاح وسر العميل، ولكل منها زر «نسخ». لن ترى السر مرة أخرى: لا تحتفظ أيدي إلا بتجزئته، ولا يُحفظ على هذا الجهاز. اضغط «حفظت السر» بعد نسخه.
لم تُجب أيديإن انقطع الاتصال أثناء الإنشاء أو التدوير فربما نُفّذ الطلب. يصبح الزر «إعادة المحاولة» ويرسل الطلب نفسه بالمفتاح نفسه: فإن كان قد نُفّذ تعود إليك البيانات والسر نفسها ولا يُنشأ عميل ثانٍ. إن تغيّر النموذج بعد الفشل فتلك محاولة جديدة. وإن مضت مدة الاحتفاظ بالسر (٢٤ ساعة افتراضيًا) أو أُلغي المفتاح فلا يُعرض السر، ودوّره لتحصل على سر جديد.

تفاصيل العميل

الحقلالمعنى
قائمة العملاءكل عميل: اسمه، وتحته عدد صلاحياته وعدد فروعه (أو «كل الفروع»)، وشارة الحالة. اختر عميلًا لعرض تفاصيله.
اسم العميل ومعرّفه ونطاق فروعه وتاريخ إنشائه وحالتهللقراءة فقط. client_id هو ما يرسله التكامل مع سرّه إلى عنوان الرمز.
نسخة العميل · expected_versionللقراءة فقط. نسخة العميل التي يرسلها التعديل؛ إن غيّر أحد العميل منذ فتحته يُرفض التعديل وتُطلب إعادة فتحه.
الصلاحياترقاقات للقراءة بالصلاحيات الممنوحة. تُقرأ من جديد مع كل طلب، فيسري التعديل من الطلب التالي للعميل.
مفاتيح السرمفتاح لكل جيل من سر العميل النشط: معرّفه وتاريخ صدوره وحالته (صالح أو ملغى) وتاريخ إلغائه. كل تدوير يضيف مفتاحًا، وتبقى المفاتيح الأقدم صالحة حتى تُلغى هنا. لا يظهر السر نفسه أبدًا.
إلغاء المفتاحزر على كل مفتاح صالح يطلب التأكيد ثم يلغي ذلك المفتاح وحده؛ تبقى مفاتيح العميل الأخرى صالحة. إن كان المفتاح الصالح الوحيد تحذّر النافذة من أن العميل لن يحصل على رمز حتى تدوّر سرًا جديدًا. لا يمكن التراجع.

العمليات التي تدعمها الواجهة

الحقلالمعنى
تعديل العميليفتح نافذة الاسم والصلاحيات والفروع مع «سبب التغيير» (من ٥ إلى ٢٤٠ حرفًا). لا يُرسل إلا ما تغيّر، ويبقى client_id والأسرار كما هي. غير متاح لعميل ملغى.
تدوير السريصدر سرًا جديدًا يظهر مرة واحدة في نافذة «انسخ السر الآن». يبقى السر القديم صالحًا حتى تلغيه من «مفاتيح السر»، فانقل الأنظمة إلى الجديد أولًا ثم ألغِ القديم.
إلغاء العميليلغي العميل نهائيًا بسبب من ٥ إلى ٢٤٠ حرفًا مكتوب في حقل «السبب»، ويُسجَّل في التدقيق، ويتوقف العميل من طلبه التالي. أقل من خمسة أحرف يُرفض قبل الإرسال.

اشتراكات الويبهوك

الحقلالمعنى
الاسم والعنوان والإخفاقاتاسم الاشتراك كما أُنشئ من لوحة معلومات التاجر، وعنوان الاستقبال، وعدد الإخفاقات المتتالية.
إرسال حدث اختبارييسلّم حدثًا اختباريًا واحدًا إلى العنوان الفعلي لا محاكاة. يُقفل بلا الميزة في الخطة.

الشريط الجانبي وحالة القفل

الحقلالمعنى
ما تكتبه هذه العمليات / القواعدما يذهب إلى الخادم لكل عملية، وأربع قواعد: السر يظهر مرة واحدة فإن ضاع فدوّره؛ نطاق الفروع الفارغ يعني كل الفروع؛ الإلغاء يحتاج سببًا من خمسة أحرف؛ الحدث الاختباري يُسلَّم إلى العنوان الفعلي.
خطتك لا تشمل هذالوحة أعلى الشاشة تظهر عندما لا تشمل الخطة ميزة الواجهة، تسمّي الخاصية وتعرض «عرض الخطة والفواتير». تبقى القراءة، وتُقفل الإنشاء والتعديل والتدوير والإلغاء والحدث الاختباري.
هذا القسم غير متاحتحلّ محل الشاشة عندما لا تستجيب قراءة العملاء، ومحل جدول المفاتيح أو الاشتراكات عندما لا تستجيب قراءتها. «إعادة المحاولة» تعيد القراءة.