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