This commit is contained in:
Marat Mashkov 2023-02-09 17:31:45 +03:00
parent 6255eab9c7
commit fb6ce63691
1 changed files with 19 additions and 4 deletions

View File

@ -15,7 +15,10 @@ $cbAPI = new ClientbaseAPI('[URL вашей CRM]', '[Токен для дост
### Как пользоваться
```
Пример использования методов класса для получения данных из CRM:
```php
//Получаем список пользовательских таблиц
$tables = $cbAPI->getTablesList();
foreach ($tables as $table) {
@ -28,20 +31,32 @@ foreach ($tables as $table) {
### Все методы
#### Таблицы
* **getTablesList()** - получить список пользовательских таблиц
* **getTable(int $tableId, bool $includeFields=false)** - получить информацию о таблице, включая информацию о полях
#### Данные в таблицах
* **getDataList(int $tableId, int $offset=0, int $limit=0, mixed $filter='')** - получить список записей таблицы c ограничением количества и выборкой по фильтру
* **getData(int $tableId, int $lineId)** - получить информацию о записи в таблице
* **getData(int $tableId, int $lineId)** - получить информацию о записи в таблице
* **getFile(int $tableId, int $fieldId, int $lineId, string $fileName)** - получить информацию файле из поля типа "Файл" в записи
* **deleteData(int $tableId, int $lineId)** - удалить запись из таблицы
* **addData(int $tableId, array $data)** - добавить запись в таблицу
* **updateData(int $tableId, int $lineId, array $data)** - обновить запись в таблице
#### Пользователи
* **getUsersList()** - получить список пользователей
* **getUser(int $userId)** - получить информацию о пользователе
#### Группы пользователей
* **getGroupsList()** - получить список групп пользователей
* **getGroup(int $groupId)** - получить информацию о группе пользователей
#### Запрос к API
* **query(string $path, string $method="GET", array $urlQuery = [], $body = null)** - произвольный запрос к API