Расширения Pyrus

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

Все расширения находятся на странице маркетплейса. Они видны и доступны для установки всем пользователям Pyrus.

Типичный сценарий обмена данными представлен на следующей схеме:

Возможности расширений

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

• вести онлайн-переписку во внешнем канале прямо из задачи;
• регистрировать и обрабатывать звонки из системы телефонии;
• синхронизировать объекты во внешней системе с задачами по форме Pyrus;
• уведомлять Pyrus о событиях во внешней системе;
• и многое другое.

Для установки расширения пользователь Pyrus должен быть зарегистрирован во внешней системе. Авторизация во внешней системе происходит при установке расширения в форму.

Как создать собственное расширение?

Чтобы создать собственное расширение и сделать его доступным для всех пользователей Pyrus вам потребуется:

• зарегистрировать свою организацию в Pyrus;
• развернуть на своем сервере или в облаке веб-сервис, который будет обрабатывать запросы от Pyrus и внешней системы. Веб-сервис должен иметь реализацию необходимых для работы расширения HTTP-методов;
• настроить расширение в личном кабинете разработчика;
• пройти модерацию;
• опубликовать расширение;
• осуществлять техническую поддержку клиентов и выпускать обновления.

Настройка расширения в личном кабинете

1. Войдите в раздел Расширения в нижнем правом углу экрана.

2. Откройте вкладку Разработка расширения в верхней панели.

3. Нажмите Начать разработку.

4. Введите название расширения, а также информацию о вашей компании: электронную почту, сайт и т.д. Обратите внимание, что название компании и адрес ее веб-сайта будут отображаться в общем каталоге и на странице расширения. Название же самого расширения будет отображаться только в личном кабинете разработчика. Нажмите ОК.

5. Далее вы автоматически получите логин и секретный ключ для доступа к Pyrus API. В открывшемся окне нажмите ОК.

   Обратите внимание: секретный ключ может быть в любой момент отозван и изменен администратором расширения или системой безопасности Pyrus.

6. Настройте основные параметры вашего расширения.

   • введите адрес веб-сервиса, развернутого на вашем собственном сервере или в облаке, который будет обрабатывать запросы от Pyrus и внешней системы.

   • для авторизации пользователя расширения в вашем сервисе укажите:

     • либо параметры для доступа к сервису по ключам авторизации (не более 5 параметров);
     • либо ссылку для авторизации по протоколу OAuth 2.0, а также данные, необходимые для того, чтобы ваш сервис идентифицировал запрос от Pyrus — ID клиента (clientID, параметр, аналогичный логину); секретный ключ клиента (clientSecret, аналогичный паролю) и права доступа, которые ваш сервис предоставляет Pyrus при авторизации пользователя (Scope).

   Подробнее об авторизации во внешней системе

   Нажмите Продолжить.

7. При необходимости подключите дополнительный функционал Pyrus, который будет поддерживать ваше расширение:

   • API-телефонию — создание заявки по форме при обращении клиента по телефону;
   • возможность задать маршрутизацию заявки по форме — преднастроенный маршрут согласования;
   • отправку приветственного сообщения клиенту после его первого обращения;
   • поддержку онлайн-чатов — создание заявок в Pyrus из обращений клиентов в чат мобильного приложения или в чат на сайте.

8. Установите, какая информация будет попадать из вашего сервиса в поля формы Pyrus и/или наоборот. Здесь же можно задать обязательность заполнения выбранных полей в форме Pyrus. Для настройки обмена вам доступны следующие поля в Pyrus.

9. Опишите назначение вашего расширения кратко и развернуто, приложите инструкцию по настройке, а также задайте названия полей, которые будут заполняться в Pyrus. Здесь же можно задать языки интерфейса, которые поддерживаются в Pyrus.

   Обратите внимание: все параметры и описания необходимо заполнить для каждого языка отдельно.

   

10. Загрузите аватарку вашего расширения и выберите тэги, по которым можно будет найти ваш сервис в каталоге расширений Pyrus.

11. Укажите данные разработчика расширения.

12. Выберите форму Pyrus, к которой будет подключено расширение.

13. Введите авторизационные данные пользователя вашего сервиса и нажмите Подключить аккаунт. Готово: личный кабинет разработчика расширений настроен и подключен.

14. Оцените, как выглядит ваше расширение в интерфейсе Pyrus, используя функцию Предпросмотр.

Публикация расширения

Для того, чтобы расширение стала доступна всем пользователям Pyrus, её нужно опубликовать на странице расширений. Публикация возможна только после успешного прохождения модерации.

После настройки личного кабинета вы увидете оповещение, что версия готова к модерации. Нажмите кнопку Отправить на модерацию.

Статус расширения изменится на Ожидает модерации.

Модерация занимает до 3 рабочих дней. Если она пройдет успешно, в личном кабинете появится кнопка Опубликовать. Нажмите на нее и ваше расширение будет доступно пользователям в каталоге расширений Pyrus. Если модерация не пройдена, вы получите уведомление в личном кабинете, письмо с разъяснением на указанную электронную почту и сможете доработать свое расширение, а затем отправить расширение на модерацию повторно.

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

Версии расширения

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

Для каждой версии создается отдельная вкладка на странице разработки расширения.

Версии могут иметь следующий статус.

1. В разработке — устанавливается при создании новой версии расширения.

2. Ожидает модерации — устанавливается, когда новая версия расширения отправляется на модерацию перед публикацией.

3. Версия отозвана разработчиком — устанавливается, если разработчик отозвал опубликованную версию расширения.

4. Готова к публикации — устанавливается после прохождения модерации в случае, если вы решили не публиковать расширение сразу после модерации.

5. Отказано в публикации — устанавливается, если текущая версия расширения не прошла модерацию.

6. Опубликована — устанавливается после публикации версии расширения. Расширение доступно всем пользователям Pyrus на странице маркетплейса. При публикации новой версии предыдущая версия с этим статусом считается устаревшей.

7. Технический сбой — устанавливается только для опубликованной версии расширения в случаях, если ваш сервер перестает отвечать на запросы или если устарел сертификат HTTPS.

Сопоставление информации из внешней системы с полями формы

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

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

Параметры расширения

Открыв вкладку Параметры в панели администрирования расширения, вы можете:

1. посмотреть логин и секретный ключ вашего расширения.

2. сбросить секретный ключ;

3. указать несколько email-адресов для рассылки уведомлений от Pyrus о состоянии вашего расширения. По умолчанию уведомления отправляются пользователю, создавшему расширение;

4. предоставить доступ к панели администрирования расширения.

5. удалить расширение.

Управление доступом к администрированию расширения

Чтобы управлять доступом к администрированию расширения, войдите во вкладку Параметры. Существует два уровня доступа к администрированию расширения:

1. Владелец — разрешено все.

2. Администратор — разрешено все, кроме удаления расширения.

Укажите пользователей и уровень доступа, который хотите им предоставить в соответствующей таблице и нажмите Сохранить. Пользователи должны быть членами вашей организации в Pyrus. Пользователи с уровнем доступа Администратор не могут управлять доступом пользователей с уровнем Владелец. Пользователь, создавший расширение, становится его Владельцем автоматически.

Помимо описанных доступов, сотрудники вашей организации с правами на управление интеграциями имеют доступ уровня Владелец ко всем расширениям, которые разработала ваша организация.