API — это интерфейс программирования, который позволяет создавать, редактировать и управлять данными в Syenrgy CRM через ваше приложение. Интеграция СRМ по API помогает «связать» с нашей системой любой софт: программа будет сама синхронизироваться с приложениями и корпоративным ПО. Больше никакой рутины и переноса информации вручную!

Например, бухгалтерия оформит закрывающие документы по сделке в 1С, и это сразу отобразится в CRM, с которой работает отдел продаж. Вы избавитесь от ошибок, связанных с ручным копированием информации, и улучшите взаимодействие между подразделениями компании.

API Synergy CRM реализован на основе спецификации JSON API. Документация для разработчиков расположена по адресу api.syncrm.ru.

Для получения API ключа перейдите в раздел настроек. Выберите пункт API и нажмите кнопку добавить "+".
В созданном поле введите название, указывающее на цель использования ключа, чек-бокс "Активный" должен быть поставлен.

В нашей CRM системе можно делать очень много, но при условии, что Вам действительно это нужно и Вы уже так работали.

В настройках системы, в подразделе "Интеграции" выбираем интеграцию, "Synergy API", далее в появившемся окне указываем:

• адрес заказа звонка (например https://my_telephony_host.ru/order/call)

После сохранения формы, в блоке с телефониями появится ваша интеграция. Кликнув вашей телефонии, отобразится модальное окно, в котором будет указан URL уведомлений (вида https://telephony.app.syncrm.ru/telephony_external...), на который необходимо будет отправлять POST запросом информацию о звонках. Так же в этом окне необходимо будет указать каким сотрудникам какие внутренние номера соответствуют.

2. Заказ звонка из Synergy CRM
После того, как пользователям будут присвоены внут. номера, то любое нажатие на номер контакта/компании будет вызывать popover-окно, где можно будет инициировать заказ звонка. Технически в этот момент произойдет отправка POST-запроса на URL который указан в первом пункте, в теле POST-запроса будут указаны:

Расчет поля signature был выполнен методом MD5 от строки: dst_phone79876543211src_phone200TOKEN В качестве ответа на запрос, ожидается получение 200 серверного статуса. При многократном (5 попыток) получении статуса отличного от 200, интеграция клиента в Synergy CRM переводится из активного, в неактивный режим и указывается причина. Signature поле заполняется только в случае, когда в настройках интеграции выставлен флаг "Проверка данных".

3. Уведомления о звонках из АТС в Synergy CRM
Для доставки информации о звонках в Synergy CRM необходимо на выданный URL (см 1 пункт) отправлять POST запросом следующие атрибуты звонка:

* Обязательные поля Уточнение по обязательным полям, в зависимости от направления звонка

Сценарий доставки уведомлений может быть двух видов:

1. Отправка уведомлений по мере их инициализации на сервере телефонии.

Например, как только поступил входящий звонок, то формируется запрос в котором указаны: src_phone=79876543211, dst_phone=200 и started_at=2022-02-22T12:22:22.222+03:00, call_id=MasOIEqwe1aq

Далее, как только была поднята трубка, то отправляется ещё один запрос с дополненными атрибутами: src_phone=79876543211, dst_phone=200, started_at=2022-02-22T12:22:22.222+03:00, call_id=MasOIEqwe1aq, status=answered, answered_at=2022-02-22T12:22:22.222+03:00.

Далее, звонок был завершен, повторяем отправку с новой информацией: src_phone=79876543211, dst_phone=200, started_at=2022-02-22T12:22:22.222+03:00, call_id=MasOIEqwe1aq, status=answered, answered_at=2022-02-22T12:22:22.222+03:00, completed_at=2022-02-22T12:22:22.222+03:00, duration=2000, recording=https://host/audio.mp3.

Не забываем, что каждый запрос должен содержать рассчитанный хэш в поле signature (только если опция проверки данных включена в настройках интеграции).

1. Отправка уведомлений (один звонок == одно уведомление).

По окончанию звонка или по таймауту сервер телефонии делает отправку истории звонков. В момент обработки уведомлений на стороне Synergy CRM происходит следующее:

• Принимается POST запрос, инициализируются обработчики интеграции клиента
• Проверяется валидность и значение поля signature
• Создается звонок
• Если звонок входящий, то пользователям, находящимся в онлайне, отображается тостер (окно в нижнем правом углу) в котором перечислены ссылки на компании и контакты, которые имеют этот же самый номер, что и в звонке. Далее, если пользователь нажмет на гиперссылку, то откроется миникарточка объекта.
• Формируется ответ SynergyCRM в ответ на POST запрос отвечает 200 серверным статусом, а так же в теле ответа содержится json с информацией по созданному объекту звонка.

Дополнение: Синхронный ответ с телом объекта, в ближайшее время будет заменен на ID звонка в очереди обработки звонков, узнать о статусе обработки можно будет воспользовавшись методами https://api.syncrm.ru/#telephony_calls.

Целостность запросов как в случае с заказом звонка, так и в случае с уведомлениями можно проверить по хэшу в поле signature. Для этого необходимо сгенерировать хэш алгоритмом md5 от строки параметров и значений, отсортированной в алфавитном порядке по имени ключа и добавленным токеном в конец этой строки.