XenForo [Hampel] API endpoint: Find a User by Criteria 1.0.2

Добавлена новая конечная точка в контроллер API пользователей, позволяющая разработчикам получать данные пользователя на основе одного из трех критериев:

user_id (идентификатор пользователя)

email (адрес электронной почты)

username (имя пользователя)

Все параметры необязательны, и если указано более одного, поиск выполняется по каждому критерию в указанном порядке.

Например, если указаны все три параметра и найдено совпадение по user_id, этот пользователь будет возвращен независимо от параметров email или username. Аналогично, если user_id не найден, но найден адрес электронной почты, то будет возвращен пользователь с этим адресом электронной почты, независимо от указанного имени пользователя.

Конечная точка доступна по адресу: GET users/find-criteria

Это дополнение было создано, чтобы помочь мне интегрировать мои форумы с моей системой службы поддержки (HelpSpot). При просмотре запросов в службу поддержки в HelpSpot мы можем выполнить "Live lookup" (живой поиск) во внешней системе для получения данных пользователя для отображения и/или хранения в системе службы поддержки. В моем случае он запрашивает мои форумы и возвращает такую информацию, как имя пользователя, статус пользователя, дата регистрации и даже ссылку на профиль пользователя на форумах.



Иногда у меня есть user_id, иногда у меня есть адрес электронной почты, а иногда у меня есть имя пользователя - поэтому система просто отправляет то, что у нее есть, в XenForo API, а затем возвращает найденного пользователя. Обратите внимание, что существует промежуточный компонент, который преобразует запрос HelpSpot в вызов XenForo API, а затем преобразует возвращаемые данные пользователя из XenForo в формат XML, требуемый HelpSpot.

Требования:

Вам понадобится ключ API с областью действия user:read, и если вы хотите получать данные адреса электронной почты в ответе, пользователю API также потребуются права администратора с разрешением "Управление пользователями и модераторами".

Ответ:

В возвращаемых данных ответа есть два основных элемента:

user - содержит полную запись пользователя в соответствии с типом данных пользователя.

urls - список URL-адресов для получения дополнительной информации об этом пользователе:

api - ссылка на вызов API для получения информации об этом пользователе непосредственно на основе идентификатора пользователя (из основного API).

public - ссылка на публичный профиль XenForo для этого пользователя.

admin - ссылка на профиль администратора XenForo для этого пользователя.