Как использовать метод SDK user.search в Битрикс24

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Как использовать метод SDK user.search в Битрикс24». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Описание метода SDK user.search

Метод user.search является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. This method is used to retrieve list of users with expedited personal data search.

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\User\Service\User со следующей сигнатурой:

public function search(
      array $filterFields
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод search:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода user.search
    $filterFields = [];

    // Выполнение запроса через Scope getUserScope и сервис user
    $result = $serviceBuilder->getUserScope()->user()->search(
          $filterFields
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода user.search: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://training.bitrix24.com/rest_help/users/user_search.php
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk