cbapi.js

cbapi.js позволяет работать с API «Клиентской базы».

Если вы ищете серверное решение на PHP, то обратите внимание на CBAPIClerk.

Установка

1. Скачайте последний релиз пакета и распакуйте в папку вашего проекта.

2. В консоли, будучи в папке проекта, выполните команду npm install или yarn install, в зависимости от того, как менеджером пакетов вы привыкли пользоваться.

3. Подключите файл cbapi.js к вашему проекту.

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

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

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

Работа методов класса базируется на обращении к методу CBAPI.command(), который, в свою очередь, работает на основе функции fetch(). Соответственно, вся работа с методами класса должна строиться в асинхронном стиле, как с промисами.

Пример:

const auth = async () => {return await window.cbapi.userList()}
auth().then((answer) => {console.log(answer)})

Данный пример должен вывести в консоль ответ от «Клиентской базы» с информацией обо всех пользователях.

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 сущности в системе