Расширения Pyrus

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

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

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

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

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

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

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

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

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

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

Для настройки расширения войдите в свой аккаунт Pyrus, откройте вкладку Разработка на странице расширений.

Нажмите Создать новое расширение. Введите название расширения и сайт компании-разработчика (необязательно), email для отправки уведомлений и название организации подставляются автоматически.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Чтобы отправить версию на модерацию выполните следующие действия.

1. На вкладке версии:

   • загрузите изображение-логотип вашего расширения;
   • заполните поля, которые будут отображаться на странице расширения.

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

3. Модерация занимает до 3 рабочих дней. Чтобы успешно пройти её, вы должны соблюсти следующие правила:

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

4. Если модерация пройдена, статус версии расширения изменится на Готова к публикации. Перейдите на вкладку версии и нажмите Опубликовать. Статус версии изменится на Опубликована, и она станет доступна на странице расширений. Если при отправке версии на модерацию вы указали, что хотите опубликовать ее сразу после прохождения, это произойдет автоматически.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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