infernusophiuchus / cbapiclerk
这将帮助您处理客户基础API。
Requires
- php: >=7.3
This package is auto-updated.
Last update: 2024-09-05 03:44:18 UTC
README
CBAPIClerk 是一个模块,允许您无需过多关注实现细节即可与“客户基础”CRM系统API交互。
安装
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)
备注:
$command — 包含请求参数的数组(见 https://clientbase.ru/help/for_admin_16/api/)
$id — 系统中实体的ID,类型 int