SalesEnergy CRM API



SalesEnergy CRM © 2014-2024

Введение

API создано для интеграции со внешними системами.

Host: https://salesenergy.ru

Авторизация

Большинство представленных методов доступны только с авторизацией. Для авторизации передавайте Bearer Token в хеадере запроса. Токен можно получить в личном кабинете в разделе "настроек" для вашей компании.

Основные объекты и методы

Доступ к обьектам осуществляется через API.

Валютыv1

Через API можно получить список валют и их стандартные коды ISO.

Метод API Описание
GET /api/public/currencylist/ Метод для получения списка валют.

Заявкиv1

Через API можно настоить получение в систему заявок из внешних систем.

Метод API Описание
GET /api/v1/leads/ Получение активных заявок из CRM.
POST /api/v1/leads/
{
"title": "тестовый лид из-вне",
"lead": "описание лида",
"type": "Письмо",
"channel": "Рассылки",
"firstname": "Семен",
"secondname": "",
"lastname": "Г.",
"phone": "+73452578942",
"email": "[email protected]",
"firm": {
"brandname": "\u042d\u041d\u0415\u0420\u0413\u041e\u0421\u041d\u0410\u0411",
"title": "\u041e\u041e\u041e \u00ab\u042d\u041d\u0415\u0420\u0413\u041e\u0421\u041d\u0410\u0411\u00bb",
"inn": "7203378552",
"kpp": "720301001",
"city": "\u0422\u044e\u043c\u0435\u043d\u044c"
},
"manager_id": 83
} 		Создание заявки в CRM.

Номенклатураv1

Через API можно получить и изменять информацию позиций номенклатурного справочника.

Метод API Описание
GET /api/v1/nomenclature/ Получение список позиций номенлатурного справочника.
POST /api/v1/nomenclature/
{
"title": "Новый склад",
"identificator_1c": "asdf"
} 		Создание новой единицы товара или услуги в номиенклатурном справочнике.
GET /api/v1/nomenclature/:id/
{
"title": "Новое название склада",
"identificator_1c": "asdf"
} 		Получение информации по конкретной позиции номенклатурного справочника
PUT /api/v1/nomenclature/:id/
{
"title": "Новое название склада",
"identificator_1c": "asdf"
} 		Обновление данных позиции номенклатурного справочника.
DELETE /api/v1/nomenclature/:id/ Удаление позиции номенклатурного справочника.

Складыv1

Через API можно получить информацию как о складах, так и о конкретном складе.

Метод API Описание
GET /api/v1/warehouses/ Получение информации о складах компании.
POST /api/v1/warehouses/
{
"title": "Новый склад",
"identificator_1c": "asdf"
} 		Создание нового склада.
PUT /api/v1/warehouse/:id/
{
"title": "Новое название склада",
"identificator_1c": "asdf"
} 		Обновление данных склада.
DELETE /api/v1/warehouse/:id/ Удаление склада, включая все го содержимое.

Товары на складахv1

Через API можно получить информацию как о товарных остатках. Также можно их обновлять.

Метод API Описание
GET /api/v1/positions/:id/ Получение информации о содержимом складе с id=1.
POST /api/v1/positions/:id/
[{
"quantity": 500,
"measure_code": 21, // единицу измерения как-то надо получить ?
"price_ppu": 0, // цена за ед без НДС, надо ли НДС отдельно передавать?
"currency_code": 0, // код валюты для цены ?
"title": "Sm-thing 1", // данные номенклатуры
"title_full": "Sm-thing full title 1",
... // еще данные номенклатуры
"identificator_1c": "asdfasfas" // идентификатор позиции
}, {
"quantity": 300,
"measure_code": 21,
"price_ppu": 300,
"currency_id": 14,
"title": "Sm-thing unusual",
"title_full": "Sm-thing full unusual title",
....
"identificator_1c": "sdhsfjrww"
}] 		Создание позиций на выбранном складе.
DELETE /api/v1/positions/:id/ Учистка содержимого склада.