Класс для работы с API 2.0 CRM "Клиентская База"

ClientbaseAPI - это PHP-класс, позволяющий работать с методами API 2.0 CRM "Клиентская база".

Документация по работе с API 2.0 на сайте clientbase.ru

Начало работы

Подключите файл src/ClientbaseAPI.php к вашему проекту.

Создайте экземпляр класса ClientbaseAPI для работы с API:

$instance = new ClientbaseAPI('[URL вашей CRM]', '[Токен для доступа к API']);

Как пользоваться

Пример использования методов класса для получения данных из CRM:

//Получаем список пользовательских таблиц
$tables = $instance->getTablesList();

foreach ($tables as $table) {
    echo 'Таблица с id=' . $table->id . ' называется $table->attributes->table_name . '<br/>';
}

Примеры решения разных задач Вы можете найти в файле index.php.

Все методы

Таблицы

getTablesList()

Получить список пользовательских таблиц.

Возвращаемое значение: массив, состоящий из объектов stdObject, содержащих информацию о таблице.

getTable(int $tableId, bool $includeFields=false)

Получить информацию о таблице, включая информацию о полях.

Параметры:

• $tableId ID таблицы
• $includeFields Включить в результат информацию о полях таблицы

Возвращаемое значение: объект stdObject, содержащий информацию о таблице.

Данные в таблицах

• getDataList(int $tableId, int $offset=0, int $limit=0, mixed $filter='') - получить список записей таблицы c ограничением количества и выборкой по фильтру *$tableId ID таблицы *$offset Отступ от начала списка *$limit Количество результатов выборки *$filter Условие выборки в формате массива или строки
• getData(int $tableId, int $lineId) - получить информацию о записи в таблице *$tableId ID таблицы *$lineId ID записи в таблице
• getFile(int $tableId, int $fieldId, int $lineId, string $fileName) - получить информацию о файле из поля типа "Файл" в записи *$tableId ID таблицы *$fieldId ID поля, содержащего файл
  *$lineId ID записи в таблице *$fileName Название файла
• deleteData(int $tableId, int $lineId) - удалить запись из таблицы *$tableId ID таблицы *$lineId ID записи в таблице
• addData(int $tableId, array $data) - добавить запись в таблицу *$tableId ID таблицы *$data массив с данными записи для добавления
• updateData(int $tableId, int $lineId, array $data) - обновить запись в таблице *$tableId ID таблицы *$lineId ID записи в таблице *$data массив с данными записи для обновления

Пользователи

• getUsersList() - получить список пользователей
• getUser(int $userId) - получить информацию о пользователе *$userId ID пользователя

Группы пользователей

• getGroupsList() - получить список групп пользователей
• getGroup(int $groupId) - получить информацию о группе пользователей *$groupId ID группы пользователей

Произвольный запрос к API

• query(string $path, string $method="GET", array $urlQuery = [], $body = null) - произвольный запрос к API *$path Путь команды API *$method HTTP-метод обращения к API (GET, POST, PATCH, DELETE) *$urlQuery Query-параметры запроса в формате массива *$body Body запроса