FAQ - API

Что такое REST API и для чего оно? - это возможности UkrCRM, направленные на обеспечение автоматизированного взаимодействия и интеграции с другими системами. Такая интеграция реализуется через интерфейсы REST API.

Например, Вы настроили landing page у себя на сайте и хотите, чтоб контакты клиента, введенные им на этой странице, сразу попадали в UkrCRM, и чтобы сразу применялся какой-то алгоритм или действие. К примеру, стартует почтовая рассылка (раздел "Рассылки."). Таким образом UkrCRM становится мощнейшим инструментом для создания автоматических воронок продаж...

Добавлять клиентов в свой Список рассылки можно с помощью этого метода

!!! Важно !!!

Система проверяет наличие клиента по введенным email + phone.
- Если один из этих параметров не указан, то будет проверяться по указанному параметру.
- Если такой комбинации не будет найдено, то создастся новый клиент и добавится в Список рассылки. Также система поставит письма рассылки в очередь отправки, заложенную в логике рассылки.
- Если будет найдено несколько совпадений, то все найденные клиенты будут добавлены в список рассылки.
- Если будет найдено одно или более совпадений, то новый клиент не будет создан и у существующих НЕ БУДУТ изменены Имя / Фамилия / Отчество, т.е. чтобы не ввел клиент в своём ФИО, данные по этим полям в системе не изменятся.

URL метода
Типа запроса - POST
URL - /api/add-client-to-mailinglist

Параметр	Тип	Обязательный	Описание
ml_hash	String	Да	Хеш-код списка для API (можно найти в карточке Списка рассылки)
manager_id	Integer	Да	ID менеджера, который будет назначен клиенту (можно найти в карточке Сотрудника)
first_name	String	Нет	Имя клиента
second_name	String	Нет	Фамилия клиента
parent_name	String	Нет	Отчество клиента
email	String	Нет	email клиента
phone	String	Нет	телефон клиента
info	String	Нет	Дополнительная информация (например, с какой парковочной страницы получены данные или по какому триггеру клиент оставил свои контактные данные и т.д.)

Пример запроса

{
    "ml_hash": "9b79d170-c1d7-40a6-adc1-dedf8e35caa3",
    "manager_id": 8,
    "first_name": "Василий",
    "second_name": "Петров",
    "parent_name": "",
    "email": "sender@t2studio.org",
    "phone": "+380501122333",
    "info": "Тестовый для проверки API"
}

Пример ответа

В ответ API возвращает список (Array) клиентов (полную структуру), имеющихся в системе по набору email + phone.

[
    {
        "clientId": 9,
        "clientStatusId": 1,
        "enterpriseId": 0,
        "employeeId": 8,
        "sex": null,
        "dateBorn": null,
        "dateCreate": "2020-05-30T18:46:18.518+0000",
        "address": null,
        "comment": "30-05-2020 21:46:18 | Тестовый для проверки API",
        "clientStatus": null,
        "enterprise": null,
        "employee": null,
        "contacts": null,
        "fname": "Василий",
        "sname": "Петров",
        "pname": null,
        "fio": "Петров Василий ",
        "fi": "Василий Петров",
        "clientIdString": "9",
        "employeeIdString": "8",
        "enterpriseIdString": "0",
        "mailMain": null,
        "phoneMain": null,
        "skype": null,
        "viber": null,
        "telegram": null,
        "whatsApp": null,
        "io": "Василий ",
        "dateBornStringYYYYMMDD": "",
        "dateBornStringDDMMYYYY": "",
        "dateCreateStringYYYYMMDD": "2020-05-30",
        "dateCreateStringDDMMYYYY": "30-05-2020"
    }
]

Обрабатываемые ошибки

• Указано пустое значение хэш-кода списка рассылки - HTTP STATUS: 400 (Bad Request). Ответ "Bad ml_hash"
• Ошибочный хэш-код списка рассылки - HTTP STATUS: 404 (Not Found). Ответ: "MailingList with ml_hash: указанный_хэш-код not found"
• Указан ID менеджера, которого нет в предприятии - HTTP STATUS: 404 (Not Found). Ответ: "Manager with id: указанный_id not found"