Технические данные
- Опубликовано:
- 24.04.2018
- Обновлено:
- 25.11.2021
- Версия:
- 1.1.0
- Установлено:
- Менее 50 раз
- Подходящие редакции:
- «Первый сайт», «Старт», «Стандарт», «Малый бизнес», «Бизнес», «Корпоративный портал», «Энтерпрайз»
- Адаптивность:
- Нет
- Поддержка Композита:
- Нет
- Совместимо с Сайты24
- Нет
- Совместимо с PHP 8.1
- Нет
Пользовательское соглашение
Описание
Модуль предоставляет простые классы и методы для взаимодействия с Клиентской базой через её апи.
Использование модуляМодуль реализует все возможности, доступные в апи Клиентской базы на апрель 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 ) |
Подробнее на гитхабе: https://github.com/pavelshulaev/cb
Требования
- php 5.3 или выше;
- модуль php CURL;
- «Конструктор административной части» (rover.fadmin) 1.6.9 или выше.
1.1.0 (25.11.2021) | — модуль "Конструктор адм. части" больше не требуется — расширение "Curl" больше не требуется — оптимизация работы и рефакторинг |
1.0.1 (13.07.2019) | — исправление ошибок |
После установки на сайт, настройка производится в административной части: «Настройки» - «Настройки модулей» - «Клиентская база api».
На странице настроек необходимо ввести:
- имя сайта, на котором установлена Клиентская база (с http/https). Если КБ установлена на в корневую папку, то имя сайта следует ввести вместе с той папкой, в которую она устновлена;
- логин пользователя Клиентской базы, от лица и с правами которого будет осуществляться подключение;
- api-ключ этого пользвателя.
Для пользователя, под которым вы ходите подключиться, в настройках КБ должна стоять галочка "Включить API". |
Если все данные верны, то после сохранения настроек появится надпись [есть подключение]. После этого можно обращаться к Клиентской базе с помощью классов и методов модуля.