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

مرجع الواجهة البرمجية العامة

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

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

الاتصال

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

التطبيقات المتصلة

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

العملاء النشطون ومفاتيح الأسرار

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

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

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