documentation update
This commit is contained in:
parent
da2a03d34d
commit
7b2dc29d01
38
README.md
38
README.md
|
|
@ -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
|
||||
//Получаем список пользовательских таблиц
|
||||
$tables = $cbAPI->getTablesList();
|
||||
$tables = $instance->getTablesList();
|
||||
|
||||
foreach ($tables as $table) {
|
||||
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)_ - получить информацию о таблице, включая информацию о полях
|
||||
* _$tableId_ ID таблицы
|
||||
* _$includeFields_ Включить в результат информацию о полях таблицы
|
||||
|
||||
#### Данные в таблицах
|
||||
|
||||
* _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)_ - получить информацию о записи в таблице
|
||||
*_$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 запроса
|
||||
|
|
|
|||
|
|
@ -13,10 +13,10 @@
|
|||
require_once "src/ClientbaseAPI.php";
|
||||
|
||||
//Укажите URL вашей "Клиентской Базы"
|
||||
$url = '';//'http://localhost/distr';
|
||||
$url = 'http://localhost/distr';
|
||||
|
||||
//Укажите токен, который вы создали для работы с API в настройках "Клиентской Базы"
|
||||
$token = "P8O49OmRKgjh8EVmfCSkvKbBtyFiQpVnj0vDzNolr8xLbgdC";
|
||||
$token = "NqOrqMfcYPdyBaxz5pY8tnDb1pnSUVXe33cex1IAYmV4ofGQ";
|
||||
|
||||
//Создаем объект для работы с API
|
||||
$cbAPI = new ClientbaseAPI($url, $token);
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<?
|
||||
<?php
|
||||
|
||||
$action = $_GET['action'];
|
||||
|
||||
|
|
|
|||
|
|
@ -348,7 +348,7 @@ class ClientbaseAPI
|
|||
*/
|
||||
private function _rawToResult($rawResult)
|
||||
{
|
||||
$result = null;
|
||||
$result = [];
|
||||
|
||||
if (!empty($rawResult->data)) {
|
||||
$result = $rawResult->data;
|
||||
|
|
|
|||
Loading…
Reference in New Issue