إضافة حقول مخصصة للمستخدم غير مرئية إلى API

[Discourse]

يشرح هذا الدليل كيفية عرض بيانات حقول المستخدم المخصصة عبر واجهة برمجة التطبيقات (API) دون عرضها في بطاقة المستخدم.

مستوى المستخدم المطلوب: مسؤول

سيأخذك هذا الدليل خلال عملية جعل بيانات حقول المستخدم المخصصة متاحة عبر واجهة برمجة التطبيقات (API) دون عرضها في بطاقة المستخدم. يمكن أن يكون هذا مفيدًا عندما تحتاج إلى الوصول برمجيًا إلى بيانات المستخدم المخصصة مع إبقائها مخفية عن العرض العام.

إنشاء حقل مستخدم مخصص

1. أولاً، قم بإنشاء حقل المستخدم المخصص الخاص بك. للحصول على تعليمات مفصلة، ارجع إلى دليل إنشاء وتكوين حقول المستخدم المخصصة.
2. بمجرد إعداد الحقل المخصص الخاص بك، احفظه.
   
   

العثور على معرف حقل المستخدم المخصص

1. انتقل إلى /admin/config/user-fields.json في متصفحك.
2. حدد موقع الحقل المخصص الذي أنشأته للتو ودوّن رقم المعرف الخاص به.
   
   

تكوين الوصول إلى واجهة برمجة التطبيقات (API)

1. انتقل إلى إعدادات المسؤول في موقعك.
2. ابحث عن إعداد public user custom fields أو staff user custom fields:
   • استخدم public user custom fields إذا كنت تريد أن تكون البيانات متاحة لجميع مستخدمي واجهة برمجة التطبيقات (API).
   • استخدم staff user custom fields إذا كنت تريد تقييد الوصول إلى مفاتيح واجهة برمجة التطبيقات (API) الخاصة بالموظفين فقط.
3. أدخل الحقل المخصص بالتنسيق user_field_X، حيث X هو رقم المعرف الذي دوّنته سابقًا.
   على سبيل المثال، إذا كان معرف الحقل المخصص الخاص بك هو 7، فستدخل user_field_7.
   
   

الوصول إلى بيانات الحقل المخصص

بمجرد التكوين، سيتم تضمين بيانات الحقل المخصص في نقطة النهاية /u/[USERNAME].json ضمن قسم “User Fields”.

البحث عن المستخدمين حسب قيم الحقول المخصصة

يمكنك البحث عن المستخدمين بناءً على قيم حقولهم المخصصة باستخدام واجهة برمجة التطبيقات (API):

1. تأكد من تحديد خيار “searchable” في إعدادات الحقل المخصص.
   
   
2. استخدم نقطة النهاية /directory_items.json مع معلمات الاستعلام الخاصة بك.

إليك مثال على استدعاء واجهة برمجة التطبيقات (API):

https://yourdomain.com/directory_items.json?period=weekly&order=likes_received&name=SearchTerm&user_field_ids=1|2

• user_field_ids: حدد حقول المستخدم المخصصة التي تريد البحث فيها (على سبيل المثال، user_field_ids=5 للبحث فقط في الحقل المخصص ذي المعرف 5).
• name: مصطلح البحث الذي تريد البحث عنه في الحقول المخصصة وأسماء المستخدمين وربما الأسماء الكاملة.

ملاحظة: هذا البحث ليس حصريًا للحقول المخصصة وقد يعرض نتائج بناءً على تطابق اسم المستخدم أو الاسم الكامل أيضًا.

لمزيد من التفاصيل حول المعلمات المتاحة، راجع وثائق واجهة برمجة التطبيقات (API).

موارد إضافية

• Creating and configuring custom user fields
• Discourse API Docs
• Reverse engineer the Discourse API

[Krischan]

هذا رائع، شكرًا لك! هل هناك طريقة للعثور على مستخدم بواسطة قيمة في حقل مخصص عبر واجهة برمجة التطبيقات (API)؟

[Canapin (Coin-coin le Canapin)]

نعم، باستخدام معلمات الاستعلام:

على سبيل المثال،
https://unicyclist.com/directory_items.json?period=weekly&order=likes_received&name=Flansberrium+G29&user_field_ids=1|2

قم بتقييد حقول المستخدم المخصصة للبحث عن طريق تعديل المعلمة الأخيرة user_field_ids=1|2.
على سبيل المثال، user_field_ids=5 للبحث فقط في الحقل المخصص رقم 5.

هناك أيضًا عدد قليل من المعلمات الأخرى المتاحة التي يمكنك العثور عليها في وثائق واجهة برمجة التطبيقات (وثائق لا تذكر حقول المستخدم، ولكن يمكنك بسهولة هندسة واجهة برمجة التطبيقات العكسية.

يجب أن يكون للحقل (الحقول) المخصصة خيار البحث محددًا لكي يعمل الاستعلام:

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