infernusophiuchus/cbapiclerk

This will helps you with Client Base API.

1.0.2 2021-02-07 21:48 UTC

Requires

• php: >=7.3

MIT

• Dmitry Shumilin

README

CBAPIClerk — это модуль, позволяющий работать с API CRM-системы «Клиентская база», практически не заботясь о реализации.

Установка

composer require infernusophiuchus/cbapiclerk

Как пользоваться

Нужно создать объект:

<?php
use Infernusophiuchus\CBAPIClerk\Handle as CBAPIClerk;
use Infernusophiuchus\CBAPIClerk\Exceptions\HandleException;

try {

	$cbapiclerk = new CBAPIClerk(
		'https://your-site.ru/', // адрес вашей «Клиентской базы»
		'login', // логин пользователя с включенным доступом по API
		'apikey' // ключ, сгенерированный системой
	);

} catch (HandleException $e) {}

Работа с API «Клиентской базы» производится посредством вызова определённых методов объекта.

Методы и API-маршруты

/api/data/create — dataCrud('create', $command), dataCreate($command)

/api/data/read — dataCrud('read', $command), dataRead($command)

/api/data/update — dataCrud('update', $command), dataUpdate($command)

/api/data/delete — dataCrud('delete', $command), dataUpdate($command)

/api/group/get_list — getList('group'), groupList()

/api/table/get_list — getList('table'), tableList()

/api/table/get_perms — tableDetails('perms', $id), tablePerms($id)

/api/table/info — tableDetails('info', $id), tableInfo($id)

/api/user/get_list — getList('user'), userList(),

/api/data/files — files($command)

P.S.:

$command — массив с параметрами запроса (см. https://clientbase.ru/help/for_admin_16/api/)

$id — ID сущности в системе, тип int