documentation update
This commit is contained in:
parent
7b2dc29d01
commit
18a80f44c7
19
README.md
19
README.md
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
<a href="https://clientbase.ru/help/for_admin_16/api_2.html" target="_blank">Документация по работе с API 2.0 на сайте clientbase.ru</a>
|
||||
|
||||
### Начало работы
|
||||
## Начало работы
|
||||
|
||||
Подключите файл `src/ClientbaseAPI.php` к вашему проекту.
|
||||
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
$instance = new ClientbaseAPI('[URL вашей CRM]', '[Токен для доступа к API']);
|
||||
```
|
||||
|
||||
### Как пользоваться
|
||||
## Как пользоваться
|
||||
|
||||
Пример использования методов класса для получения данных из CRM:
|
||||
|
||||
|
|
@ -31,11 +31,12 @@ foreach ($tables as $table) {
|
|||
Примеры решения разных задач Вы можете найти в файле `index.php`.
|
||||
|
||||
|
||||
### Все методы
|
||||
## Все методы
|
||||
|
||||
#### Таблицы
|
||||
### Таблицы
|
||||
|
||||
#### getTablesList()
|
||||
|
||||
##### getTablesList()
|
||||
Получить список пользовательских таблиц
|
||||
|
||||
Возвращаемое значение: массив, состоящий из объектов stdObject, содержащих данные таблицы.
|
||||
|
|
@ -45,7 +46,7 @@ foreach ($tables as $table) {
|
|||
* _$tableId_ ID таблицы
|
||||
* _$includeFields_ Включить в результат информацию о полях таблицы
|
||||
|
||||
#### Данные в таблицах
|
||||
### Данные в таблицах
|
||||
|
||||
* _getDataList(int $tableId, int $offset=0, int $limit=0, mixed $filter='')_ - получить список записей таблицы c ограничением количества и выборкой по фильтру
|
||||
*_$tableId_ ID таблицы
|
||||
|
|
@ -71,19 +72,19 @@ foreach ($tables as $table) {
|
|||
*_$lineId_ ID записи в таблице
|
||||
*_$data_ массив с данными записи для обновления
|
||||
|
||||
#### Пользователи
|
||||
### Пользователи
|
||||
|
||||
* _getUsersList()_ - получить список пользователей
|
||||
* _getUser(int $userId)_ - получить информацию о пользователе
|
||||
*_$userId_ ID пользователя
|
||||
|
||||
#### Группы пользователей
|
||||
### Группы пользователей
|
||||
|
||||
* _getGroupsList()_ - получить список групп пользователей
|
||||
* _getGroup(int $groupId)_ - получить информацию о группе пользователей
|
||||
*_$groupId_ ID группы пользователей
|
||||
|
||||
#### Произвольный запрос к API
|
||||
### Произвольный запрос к API
|
||||
|
||||
* _query(string $path, string $method="GET", array $urlQuery = [], $body = null)_ - произвольный запрос к API
|
||||
*_$path_ Путь команды API
|
||||
|
|
|
|||
Loading…
Reference in New Issue