Благодаря API можно в других системах обмениваться данными с impulseCRM.
API impulseCRM построена на http Basic авторизации. Чтобы получить ключ авторизации, нажмите на иконку текущего профиля и надпись "Настройка API":
Нажимаем на кнопку "Обновить ключ":
Полученный ключ нужно отправлять при каждом запросе в заголовке авторизации. Посмотреть рабочий пример можно нажав на кнопку "Пример запроса":
Описание запросов
В ссылке запроса всегда указывается название сущности и экшен:
У всех сущностей системы реализованы 5 экшенов:
Операция;Экшен;Тип запроса
Список сущностей;list;POST
Создание сущности;update (без указания id);GET
Считывание сущности;load;POST
Изменение сущности;update (с указанием id);POST
Удаление сущности;delete;POST
В теле запроса можно передавать следующие параметры:
Название;Описание;Тип данных
fields;Какие колонки выгружать. Если не указывать, то все поля выгрузятся. При изучении структуры БД можно не выгружать, но в релизе для быстродействия рекомендуем указывать;array
limit;Сколько записей выгружать. Если не указывать, то все записи выгрузятся;integer
page;Какую страницу выборки выгружать;integer
sort;По какой колонке сортировать;array
columns;По каким колонкам фильтровать;array