infernusophiuchus/cbapiclerk

这将帮助您处理客户基础API。

1.0.2 2021-02-07 21:48 UTC

This package is auto-updated.

Last update: 2024-09-05 03:44:18 UTC


README

CBAPIClerk 是一个模块,允许您无需过多关注实现细节即可与“客户基础”CRM系统API交互。

версия версия PHP

安装

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/createdataCrud('create', $command), dataCreate($command)

/api/data/readdataCrud('read', $command), dataRead($command)

/api/data/updatedataCrud('update', $command), dataUpdate($command)

/api/data/deletedataCrud('delete', $command), dataUpdate($command)

/api/group/get_listgetList('group'), groupList()

/api/table/get_listgetList('table'), tableList()

/api/table/get_permstableDetails('perms', $id), tablePerms($id)

/api/table/infotableDetails('info', $id), tableInfo($id)

/api/user/get_listgetList('user'), userList(),

/api/data/filesfiles($command)

备注:

$command — 包含请求参数的数组(见 https://clientbase.ru/help/for_admin_16/api/

$id — 系统中实体的ID,类型 int