Модуль предоставляет простые классы и методы для взаимодействия с Клиентской базой через её апи.
Использование модуляМодуль реализует все возможности, доступные в апи Клиентской базы на апрель 2018 года.
Взаимодействие с Клиентской базой возможно как с помощью классов сущностей, так и с помощью основного класса \Rover\CB\Rest. Классы сущностей являются обёрткой над \Rover\CB\Rest и реализуют более удобные методы для доступа к конкретным сущностям КБ.Классы сущностей расположены в пространстве имён \Rover\CB\Rest\. Их методы практически идентичны аналогичным методам апи КБ.
Подробнее о методах на гитхабе проекта: https://github.com/pavelshulaev/cb
Получение списка пользователей с помощью класса Rover\CB\Rest\User:
use Bitrix\Main\Loader; use Rover\CB\Rest\User; if (Loader::includeModule('rover.cb')) { try{ $users = User::getInstance()->getList(); echo '<pre>'; print_r($users); echo '</pre>'; } catch (\Exception $e){ ShowError($e->getMessage()); } } else { ShowError("Не удалось подключить модуль «Клиентская база api»"); } |
Результат будет примерно таким:
Array ( [data] => Array ( [1] => Array ( [id] => 1 [fio] => ... [group_id] => 1 [arc] => 0 ) [10] => Array ( [id] => 10 [fio] => ... [group_id] => 1 [arc] => 0 ) ... ) [count] => 5 [code] => 0 [message] => Done ) |
После установки на сайт, настройка производится в административной части: «Настройки» - «Настройки модулей» - «Клиентская база api».
На странице настроек необходимо ввести:
Для пользователя, под которым вы ходите подключиться, в настройках КБ должна стоять галочка "Включить API". |
Если все данные верны, то после сохранения настроек появится надпись [есть подключение]. После этого можно обращаться к Клиентской базе с помощью классов и методов модуля.