# Добавление невидимых пользовательских полей в API
**URL:** https://meta.discourse.org/t/adding-non-visible-user-custom-fields-to-the-api/276618
**Category:** Site Management
**Tags:** rest-api, how-to, user-custom-fields, users
**Created:** [25.Август.2023 14:46:39 UTC](https://meta.discourse.org/t/adding-non-visible-user-custom-fields-to-the-api/276618 "2023-08-25T14:46:39Z")
**Posts on this page:** 3
**Page:** 1
### Author:  [@Discourse](https://meta.discourse.org/u/Discourse)
#### Post date: [25.Август.2023 14:46:40 UTC](https://meta.discourse.org/t/adding-non-visible-user-custom-fields-to-the-api/276618/1 "2023-08-25T14:46:40Z")
> 🔖 Это руководство объясняет, как предоставлять данные пользовательских полей через API, не отображая их на карточке пользователя.\>
>
> 🙋 Требуемый уровень доступа: Администратор
Это руководство проведет вас через процесс предоставления доступа к данным пользовательских полей через API без их отображения на карточке пользователя. Это может быть полезно, когда вам нужно программно получать доступ к пользовательским данным, сохраняя их скрытыми от общего просмотра.
## Создание пользовательского поля
1. Сначала создайте пользовательское поле. Подробные инструкции см. в [руководстве по созданию и настройке пользовательских полей](https://meta.discourse.org/t/create-and-configure-custom-user-fields/113192).
2. После настройки сохраните поле.
## Поиск ID пользовательского поля
1. Перейдите по адресу `/admin/config/user-fields.json` в вашем браузере.
2. Найдите только что созданное пользовательское поле и запишите его ID.
## Настройка доступа через 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 — это ID, который вы записали ранее.
Например, если ID вашего пользовательского поля равен 7, введите `user_field_7`.
## Доступ к данным пользовательского поля
После настройки данные пользовательского поля будут включены в эндпоинт `/u/[USERNAME].json` в разделе “User Fields” (Пользовательские поля).
## Поиск пользователей по значениям пользовательских полей
Вы можете искать пользователей по значениям их пользовательских полей с помощью API:
1. Убедитесь, что в настройках пользовательского поля отмечена опция “searchable” (доступно для поиска).
2. Используйте эндпоинт `/directory_items.json` с необходимыми параметрами запроса.
Вот пример вызова API:
```plaintext
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` для поиска только в поле с ID 5).
- `name`: Поисковый термин для поиска в пользовательских полях, именах пользователей и, возможно, полных именах.
_Примечание: Этот поиск не ограничивается только пользовательскими полями и может возвращать результаты на основе совпадений имени пользователя или полного имени._
Для получения дополнительной информации о доступных параметрах обратитесь к [документации API](https://docs.discourse.org/#tag/Users/operation/listUsersPublic).
## Дополнительные ресурсы
- [Creating and configuring custom user fields](https://meta.discourse.org/t/create-and-configure-custom-user-fields/113192)
- [Discourse API Docs](https://docs.discourse.org/#tag/Users/operation/listUsersPublic)
- [Reverse engineer the Discourse API](https://meta.discourse.org/t/reverse-engineer-the-discourse-api/20576)
---
### Author:  [@Krischan](https://meta.discourse.org/u/Krischan)
#### Post date: [18.Октябрь.2023 19:53:14 UTC](https://meta.discourse.org/t/adding-non-visible-user-custom-fields-to-the-api/276618/2 "2023-10-18T19:53:14Z")
Отлично, спасибо! Есть ли способ найти пользователя по значению в пользовательском поле через API?
---
### Author:  [@Canapin](https://meta.discourse.org/u/Canapin)
#### Post date: [18.Октябрь.2023 22:06:18 UTC](https://meta.discourse.org/t/adding-non-visible-user-custom-fields-to-the-api/276618/3 "2023-10-18T22:06:18Z")
Да, используя параметры запроса:
Например,
[https://unicyclist.com/directory\_items.json?period=weekly&order=likes\_received&name=Flansberrium+G29&user\_field\_ids=1|2](https://unicyclist.com/directory_items.json?period=weekly&order=likes_received&name=Flansberrium+G29&user_field_ids=1%7C2)
Ограничьте поиск по пользовательским полям, изменив последний параметр `user_field_ids=1|2`.
Например, `user_field_ids=5` для поиска только в пользовательском поле с ID 5.
Также доступно несколько других параметров, которые вы можете найти в [документации API](https://docs.discourse.org/#tag/Users/operation/listUsersPublic) (документация не упоминает пользовательские поля, но вы можете легко [провести реверс-инжиниринг API](https://meta.discourse.org/t/reverse-engineer-the-discourse-api/20576?u=canapin)).
Пользовательское поле (поля) должно иметь отмеченную опцию «Доступно для поиска», чтобы запрос работал:
Также обратите внимание, что запрос будет искать не _только_ в пользовательских полях, но и в именах пользователей, а возможно, и в полных именах. На мой взгляд, встроенной функции для фильтрации только по пользовательским полям не существует.