Справка

Расширения Pyrus

Платформа Pyrus может взаимодействовать с различными внешними системами (мессенджерами, социальными сетями, системами телефонии, CRM-системами и т.д.) через механизм расширений. Разработчики публикуют свои расширения на странице маркетплейса. Они доступны для установки всем пользователям Pyrus.

Расширение — это веб-сервис, который осуществляет двусторонний обмен информацией между Pyrus и внешней системой. Платформа Pyrus может вызывать расширение через механизм вебхуков, внешняя система вызывает Pyrus через вызовы Extensions API.

Функционал расширения

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

Под пользователем в разделе документации Расширения Pyrus мы подразумеваем администратора бизнес-процесса.

Типовые сценарии работы расширений:

  • Онлайн-чат. В задаче появляется внешний канал для двустороннего обмена текстовыми сообщениями. Используется для реализации интеграций с мессенджерами, социальными сетями, маркетплейсами, платформами отзывов и оценок, платформами объявлений и т.д. Поддерживается прикладывание картинок и файлов, а также возможность начать диалог из Pyrus.

  • Телефония. На каждый входящий или исходящий звонок создается задача по форме, в конце разговора его запись прикладывается в эту задачу. Созданная задача автоматически открывается у оператора, на рабочий телефон которого (указывается в профиле) поступил звонок. Разные телефонные номера организации можно привязывать к разным формам Pyrus. Используется для интеграций с провайдерами голосовых звонков.

  • Маршрутизация. Расширение запускается на определенных пользователем этапах согласования формы. Используется для интеграции с системами электронного документооборота, распознавания счетов, отправки уведомлений и т.д.

Внешняя система должна поддерживать один из способов авторизации: OAuth 2.0 (предпочтительный вариант) или авторизация по параметрам (например, по токену, логину/паролю). Pyrus поддерживает оба механизма. При установке расширения пользователю будет предложен тот способ, который реализовал разработчик расширения.

Каждое расширение умеет работать с набором полей, которые определяет разработчик (например, для телефонии это может быть А-номер, B-номер, для чата — имя или ник человека). При разработке автор расширения может указывать, какие коды полей оно ожидает. При установке расширения пользователем если в форме найдены поля с указанными кодами, маппинг между полями формы и расширения устанавливается автоматически. Если каких-то обязательных полей в форме нет, то пользователю будет предложено их добавить.

Для упрощения пользователям подключения расширений мы рекомендуем при разработке опираться на опубликованные коды полей. Список кодов полей постоянно дополняется, напишите в поддержку, если вы знаете код, который нужно добавить.

Что дальше

Была ли эта статья полезной?