Clientbase
/
api
mirror of https://github.com/clientbase-doc/api.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation update

This commit is contained in:
Marat Mashkov 2023-05-30 17:02:38 +03:00
parent da2a03d34d
commit 7b2dc29d01
3 changed files with 37 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -12,7 +12,7 @@
``` ```
$cbAPI = new ClientbaseAPI('[URL вашей CRM]', '[Токен для доступа к API']); $instance = new ClientbaseAPI('[URL вашей CRM]', '[Токен для доступа к API']);
``` ```
### Как пользоваться ### Как пользоваться
@ -21,7 +21,7 @@ $cbAPI = new ClientbaseAPI('[URL вашей CRM]', '[Токен для дост
```php ```php
//Получаем список пользовательских таблиц //Получаем список пользовательских таблиц
$tables = $cbAPI->getTablesList(); $tables = $instance->getTablesList();
foreach ($tables as $table) { foreach ($tables as $table) {
echo 'Таблица с id=' . $table->id . ' называется $table->attributes->table_name . '<br/>'; echo 'Таблица с id=' . $table->id . ' называется $table->attributes->table_name . '<br/>';
@ -35,30 +35,58 @@ foreach ($tables as $table) {
#### Таблицы #### Таблицы
* _getTablesList()_ - получить список пользовательских таблиц ##### getTablesList()
Получить список пользовательских таблиц
Возвращаемое значение: массив, состоящий из объектов stdObject, содержащих данные таблицы.
* _getTable(int $tableId, bool $includeFields=false)_ - получить информацию о таблице, включая информацию о полях * _getTable(int $tableId, bool $includeFields=false)_ - получить информацию о таблице, включая информацию о полях
* _$tableId_ ID таблицы
* _$includeFields_ Включить в результат информацию о полях таблицы
#### Данные в таблицах #### Данные в таблицах
* _getDataList(int $tableId, int $offset=0, int $limit=0, mixed $filter='')_ - получить список записей таблицы c ограничением количества и выборкой по фильтру * _getDataList(int $tableId, int $offset=0, int $limit=0, mixed $filter='')_ - получить список записей таблицы c ограничением количества и выборкой по фильтру
*_$tableId_ ID таблицы
*_$offset_ Отступ от начала списка
*_$limit_ Количество результатов выборки
*_$filter_ Условие выборки в формате массива или строки
* _getData(int $tableId, int $lineId)_ - получить информацию о записи в таблице * _getData(int $tableId, int $lineId)_ - получить информацию о записи в таблице
* _getData(int $tableId, int $lineId)_ - получить информацию о записи в таблице *_$tableId_ ID таблицы
*_$lineId_ ID записи в таблице
* _getFile(int $tableId, int $fieldId, int $lineId, string $fileName)_ - получить информацию файле из поля типа "Файл" в записи * _getFile(int $tableId, int $fieldId, int $lineId, string $fileName)_ - получить информацию файле из поля типа "Файл" в записи
*_$tableId_ ID таблицы
*_$fieldId_ ID поля, содержащего файл
*_$lineId_ ID записи в таблице
*_$fileName_ Название файла
* _deleteData(int $tableId, int $lineId)_ - удалить запись из таблицы * _deleteData(int $tableId, int $lineId)_ - удалить запись из таблицы
*_$tableId_ ID таблицы
*_$lineId_ ID записи в таблице
* _addData(int $tableId, array $data)_ - добавить запись в таблицу * _addData(int $tableId, array $data)_ - добавить запись в таблицу
*_$tableId_ ID таблицы
*_$data_ массив с данными записи для добавления
* _updateData(int $tableId, int $lineId, array $data)_ - обновить запись в таблице * _updateData(int $tableId, int $lineId, array $data)_ - обновить запись в таблице
*_$tableId_ ID таблицы
*_$lineId_ ID записи в таблице
*_$data_ массив с данными записи для обновления
#### Пользователи #### Пользователи
* _getUsersList()_ - получить список пользователей * _getUsersList()_ - получить список пользователей
* _getUser(int $userId)_ - получить информацию о пользователе * _getUser(int $userId)_ - получить информацию о пользователе
*_$userId_ ID пользователя
#### Группы пользователей #### Группы пользователей
* _getGroupsList()_ - получить список групп пользователей * _getGroupsList()_ - получить список групп пользователей
* _getGroup(int $groupId)_ - получить информацию о группе пользователей * _getGroup(int $groupId)_ - получить информацию о группе пользователей
*_$groupId_ ID группы пользователей
#### Произвольный запрос к API #### Произвольный запрос к API
* _query(string $path, string $method="GET", array $urlQuery = [], $body = null)_ - произвольный запрос к 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 запроса

6
index.php
View File

@ -13,10 +13,10 @@
require_once "src/ClientbaseAPI.php"; require_once "src/ClientbaseAPI.php";
//Укажите URL вашей "Клиентской Базы" //Укажите URL вашей "Клиентской Базы"
$url = '';//'http://localhost/distr'; $url = 'http://localhost/distr';
//Укажите токен, который вы создали для работы с API в настройках "Клиентской Базы" //Укажите токен, который вы создали для работы с API в настройках "Клиентской Базы"
$token = "P8O49OmRKgjh8EVmfCSkvKbBtyFiQpVnj0vDzNolr8xLbgdC"; $token = "NqOrqMfcYPdyBaxz5pY8tnDb1pnSUVXe33cex1IAYmV4ofGQ";
//Создаем объект для работы с API //Создаем объект для работы с API
$cbAPI = new ClientbaseAPI($url, $token); $cbAPI = new ClientbaseAPI($url, $token);
@ -35,7 +35,7 @@
</head> </head>
<body> <body>
<div class="container"> <div class="container">
<? <?php
$action = $_GET['action']; $action = $_GET['action'];

2
src/ClientbaseAPI.php
View File

@ -348,7 +348,7 @@ class ClientbaseAPI
*/ */
private function _rawToResult($rawResult) private function _rawToResult($rawResult)
{ {
$result = null; $result = [];
if (!empty($rawResult->data)) { if (!empty($rawResult->data)) {
$result = $rawResult->data; $result = $rawResult->data;