Как создать в Битрикс24 вебхук на свой кастомный обработчик?

Question

[Александр]

У меня коробочная версия портала Битрикс24. Мне необходимо реализовать поиск по элементам инфоблока (спискам) Битркис24 так чтобы можно было отправлять со стороннего сайта на мой Битрикс24 запрос по вебхук с параметрами и получать нужный список элементов из инфоблоков Битркис24. Проблема в том что в стандартном REST API нет возможности делать поиск по полям или своствам элементов инфоблока а через стандартный REST FILTER результат возвращается не правильным

Я хочу написать свой скрипт который будет размещен на стороне Битркис24, он будет принимать внешний запрос и запускать поиск по нужному инфоблоку через Битрикс API и затем возвращать полученный результат в виде json.
Далее я хочу сделать веб-хук который будет привязан к этому обработчику.

Но я не знаю как правильно сделать такой вебхук, помогите разобраться!

Есть инструкция как можно сделать кастомный обработчик REST

Я сделал по данной иструкции обработчик и привязал к нему вебхук, но вебхук возвращает такое сообщение:{"error":"ERROR_METHOD_NOT_FOUND","error_description":"Method not found!"}

Вот код обработчика:

public static function OnRestServiceBuildDescription()
    {
        return array(
            'apitest' => array(
                'api.test.list' => array(
                    'callback' => array(__CLASS__, 'getList'),
                    'options' => array(),
                ),
            )
        );
    }

    public static function getList($query, $nav, \CRestServer $server)
    {
        $navData = static::getNavData($nav, true);

        $res = \Bitrix\Main\UserTable::getList(
            [
                'filter' => $query['filter']?:[],
                'select' => $query['select']?:['*'],
                'order' => $query['order']?:['ID' => 'ASC'],
                'limit' => $navData['limit'],
                'offset' => $navData['offset'],
                'count_total' => true,
            ]
        );

        $result = array();
        while($user = $res->fetch())
        {
            $result[] = $user;
        }

        return static::setNavData(
            $result,
            array(
                "count" => $res->getCount(),
                "offset" => $navData['offset']
            )
        );
    }
}

AddEventHandler('rest', 'OnRestServiceBuildDescription', array('\ApiTest', 'OnRestServiceBuildDescription'));

В инструкции к методу возвращается массив пользователей у меня по ходу вообще веб-хук не ведет на этот метод или я что-тоне правильно делаю?

Answer 1

[Kudis]

Идеально сделать модуль и зарегистрировать один раз хэндлер при установке

EventManager::getInstance()->registerEventHandler(
    'rest',
    'OnRestServiceBuildDescription',
    $this->MODULE_ID,
    'ApiTest',
    'OnRestServiceBuildDescription'
);

Либо регистрировать его каждый раз в `/local/php_interface/init.php` через:

AddEventHandler(
    'rest',
    'OnRestServiceBuildDescription',
    ['ApiTest', 'OnRestServiceBuildDescription'],
    false,
    $_SERVER['DOCUMENT_ROOT'] . '/habr/ApiTest.php'
);

только не забудьте полный путь к классу прописать (в примере: `/home/bitrix/www/habr/ApiTest.php`)

А потом добавьте ваш scope (Вы его названи `apitest`) в разрешения хука.

Comments

[Александр]

я добавил мой scope в вебхук там он виден но вот как теперь обратится к обработчику, просто по адресу вебхука?

[Kudis]

Да, конечно вот так: `https://yourdomain.com/rest/userId/app_password/api.test.list`
т.е. копируете ссылку из хука и добавляете вызываемый метод `api.test.list`

[Nikk99rus]

Добрый день! А как в итоге решили делать реализацию - через модуль или в /local/php_interface/init.php?

Пробую через /local/php_interface/init.php, но scope в настройках входящего вебхука не появляется ни в методе, ни в настройке прав.

В init.php прописываю:

if (!\CModule::IncludeModule('rest'))
return;

AddEventHandler('rest',
'OnRestServiceBuildDescription',
['lib\REST\CTestRestProvider', 'OnRestServiceBuildDescription'],
false,
$_SERVER['DOCUMENT_ROOT'] . APP_CLASS_FOLDER . 'REST/CTestRestProvider.php'
);

В классе "CTestRestProvider":
<?php
namespace lib\rest;

class CTestRestProvider extends \IRestService
{
public static function OnRestServiceBuildDescription()
{

return array(
'apitest' => array(
'apitest.get.test' => array('callback' => array( __CLASS__, 'testFields'), 'options' => array()),
)
);

}

public static function testFields($query, $n, \CRestServer $server)
{
if($query['error'])
{
throw new \Bitrix\Rest\RestException(
'Message',
'ERROR_CODE',
\CRestServer::STATUS_PAYMENT_REQUIRED
);
}

return array('queryRequest' => $query, 'message' => 'Ok');
}

}

[Nikk99rus]

Nikk99rus, Проблема была в кэше. Нужно обязательно чистить.

Answer 2

[VadimGeg]

У меня почему то в настройках вэбхука мои методы не отображаются и в правах scope тоже не отображатеся, сделал по инструкции

Comments

[Oduvan000]

Сам долго просидел над этим. Надо сбросить кэш.

Answer 3

[Сергей Шаклеин]

Чтобы метод появился в списке вебхуков нужно сбросить кэш