Создание новых пользовательских приложений

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

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

1

Настройте URL

Укажите URL вашего приложения — адрес, по которому размещено приложение; он служит основой для интеграции.

• Убедитесь, что URL действителен, использует соединение HTTPS, ведет на надежный ресурс и содержит не более 1000 символов.

• Убедитесь, что в приложении с вашей стороны включена настройка iFrame, иначе вы не сможете открыть его в интерфейсе платформы.

2

Настройте базовые параметры

Чтобы персонализировать приложение, вы можете включать различные параметры в URL. Вы можете вручную добавить параметры в поле URL или воспользоваться одним из наших предложений: язык, идентификатор пользователя или часовой пояс. Нажмите на предложение параметра, чтобы добавить его в конец URL. Разверните описание ниже, чтобы узнать больше о предлагаемых параметрах и примерах.

Понимание предлагаемых параметров URL

Мы предлагаем некоторые базовые параметры для персонализации

1. ?locale={locale_code} Параметр языка, который автоматически совпадает с языком платформы пользователя.

• Пример: https://your-app.com/dashboard?locale=en

1. ?user_id={user_identifier} Параметр контекста пользователя, который передает идентификацию пользователя для фильтрации персонализированной информации.

• Пример: https://your-app.com/dashboard?user_id=12345

1. ?timezone={timezone} Параметр времени, который автоматически совпадает с часовым поясом платформы пользователя.

• Пример: https://your-app.com/dashboard?timezone=UTC+1

Вы можете отредактировать имя предлагаемого параметра или указать для него определенное значение.

Пример URL приложения с параметрами

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

3

Настройте внешний вид

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

• Метка – Добавьте уникальное, описательное название для вашего приложения (до 24 символов). Оно будет отображаться в боковой панели платформы.

• Описание – Добавьте краткое пояснение с деталями о функциональности приложения или выделите важную информацию (до 50 символов). Информативное описание поможет пользователям лучше понять назначение приложения.

• Иконка – Выберите значок, который будет представлять функцию вашего приложения для более нативной навигации.

4

Выберите метод отображения

Решите, как будет открываться ваше приложение, выбрав один из двух вариантов в Открывать в выпадающем списке:

• Встроенное – Приложение отображается в интерфейсе платформы

• Новой вкладке – Приложение открывается в отдельной вкладке браузера

Наша платформа использует iFrame для встраивания. Поскольку не все URL могут корректно обрабатываться этой технологией, обязательно предварительно просмотрите результат встраивания. Если вы столкнетесь с проблемами при этом методе отображения, рассмотрите возможность использования Новой вкладке.

5

Настройка аутентификации (необязательно)

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

• API key

  • Этот метод предназначен для приложений, где управление ролями или права пользователей не требуются.

  • API-ключ соответствует уровню доступа владельца учетной записи. Это означает, что предоставление обычному пользователю API-ключа может предоставить ему доступ к всем данным доступным главному пользователю. Например, если ваше приложение работает с трекерами, к которым у пользователя есть ограниченные права или вовсе нет доступа, использование API-ключа все равно откроет доступ ко всем трекерам из главного аккаунта.

• Ключ сессии

  • Этот метод рекомендуется, когда задействовано управление ролями.

  • Передает текущий ключ сессии пользователя в приложение.

Выбор API key метода автоматически отключит Ключ сессии метод и наоборот. В одно время можно использовать только один метод.

Когда аутентификация включена, платформа добавляет ?session_key= параметр к URL вашего приложения.

• Если вы выбрали API key, значение параметра будет содержать этот ключ.

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

Убедитесь, что приложение способно прочитать и использовать этот параметр.

6

Сохраните новое приложение

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

Пример вида встроенного Пользовательского приложения

Быстрые советы по устранению неполадок

Если ваше приложение некорректно отображается при встраивании, попробуйте:

• Открыть его вместо этого в новой вкладке

• Проверить, что ваш URL корректен и доступен

• Убедиться, что все параметры правильно отформатированы

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