Доступ через API

Благодаря API можно в других системах обмениваться данными с impulseCRM.

API impulseCRM построена на http Basic авторизации. Чтобы получить ключ авторизации, нажмите на иконку текущего профиля и надпись "Настройка API":

Нажимаем на кнопку "Обновить ключ":

Полученный ключ нужно отправлять при каждом запросе в заголовке авторизации. Посмотреть рабочий пример можно нажав на кнопку "Пример запроса":

Описание запросов

В ссылке запроса всегда указывается название сущности и экшен:

У всех сущностей системы реализованы 5 экшенов:

В теле запроса можно передавать следующие параметры:

Пример тела запроса (JSON):

{
"fields": ["id", "lastName", "name", "middleName"],
"limit": 10,
"page": 1,
"sort": {"created": "desc"},
"columns": {"created": {"from":1610115200, "to":1735689600} }
}

Описание сущностей

Все фактические оплаты (продажи и расходы) хранятся в сущности deposit.