Open Client API

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

Open Client API предназначен для создания клиентских приложений, которые взаимодействуют с MAX напрямую с устройства пользователя.

Доступ к Open Client API предоставляется участникам Программы разработчиков MAX. Чтобы начать работу, подайте заявку, получите сертификат участника программы и App-ID, а затем подключите приложение в соответствии с технической документацией и Лицензионным соглашением.

Подать заявку
Лицензионное соглашение

Что такое Open Client API

Open Client API — это набор программных интерфейсов, с помощью которых клиентское приложение взаимодействует с MAX.

Описание методов, параметров, форматов запросов и ответов, ограничений и других технических условий предоставляется участникам Программы разработчиков MAX.

Open Client API не относится к Платформе MAX для партнёров и её сервисам: чат-ботам, мини-приложениям, каналам и Цифровому ID. Для работы с этими сервисами используются отдельные инструменты и API, описанные в Документации MAX для партнеров.

Программа разработчиков MAX

Для использования Open Client API необходимо вступить в Программу разработчиков MAX.

Программа предназначена для разработчиков клиентских приложений для работы с MAX.

Участники программы получают:

  • App-ID для идентификации приложения;
  • доступ к полной технической документации;
  • информацию об изменениях Open Client API.

По итогам одобрения заявки MAX выдаёт разработчику сертификат участника Программы разработчиков MAX. В сертификате указываются приложение, для которого предоставлен доступ, и ключевые условия участия в программе.

Как получить App-ID

1. Подайте заявку

Направьте заявку на вступление в Программу разработчиков MAX.

В заявке необходимо указать:

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

MAX может запросить дополнительную информацию об архитектуре, функциях, безопасности приложения и порядке работы с данными.

Подать заявку 

2. Дождитесь рассмотрения заявки

MAX проверит сведения о разработчике и приложении.

При рассмотрении заявки учитываются:

  • назначение приложения;
  • соответствие разработчика и приложения установленным требованиям;
  • безопасность приложения;
  • совместимость приложения с MAX;
  • влияние приложения на безопасность и стабильность работы MAX;
  • техническая возможность предоставить запрашиваемый доступ.

Подача заявки не гарантирует подключение к программе.

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

3. Получите сертификат и App-ID

После одобрения заявки разработчик получает сертификат участника Программы разработчиков MAX и App-ID.

  • App-ID — уникальный идентификатор приложения в Open Client API. Он используется при подключении приложения и выполнении запросов.
  • App-ID предоставляется для конкретного приложения. Для другого самостоятельного приложения необходимо получить отдельный App-ID.
  • App-ID нельзя передавать другому разработчику или использовать для приложения, которое не указано в одобренной заявке.

4. Получите техническую документацию

Участнику программы предоставляется доступ к полной технической документации.

Начало работы

После получения App-ID:

  • Ознакомьтесь с Лицензионным соглашением, технической документацией и требованиями Дизайн системы.
  • Настройте приложение в соответствии с требованиями Open Client API.
  • Подключите App-ID способом, указанным в технической документации.
  • Реализуйте предусмотренные механизмы авторизации и обмена данными.
  • Настройте обработку ответов, событий, ошибок и временной недоступности Open Client API.
  • Проведите тестирование приложения.
  • Проверьте соблюдение ограничений по безопасности, работе с данными и количеству запросов.

Адреса подключения, протоколы, форматы сообщений и примеры запросов приводятся в полной технической документации.

Архитектура приложения

Приложение должно взаимодействовать с MAX напрямую с устройства пользователя.

Все запросы к Open Client API и все ответы MAX должны передаваться непосредственно между устройством пользователя и инфраструктурой MAX.

Приложение не должно использовать собственную серверную часть разработчика или серверную инфраструктуру третьих лиц.

Запрещается направлять взаимодействие с Open Client API через:

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

Данные, полученные через Open Client API, не должны передаваться на инфраструктуру разработчика или третьих лиц, в том числе в системы аналитики, рекламы, мониторинга или машинного обучения.

Работа с данными пользователей

Разработчик, его работники и подрядчики не должны получать доступ к сообщениям, контенту, контактам и другим данным пользователей MAX.

Такие данные могут обрабатываться только клиентским приложением на устройстве пользователя и только в объёме, необходимом для выполнения выбранного пользователем действия.

Запрещается:

  • скрапинг и иной автоматизированный сбор данных;
  • массовая выгрузка сообщений, контента, контактов и других данных;
  • индексирование и систематизация данных пользователей;
  • длительное хранение данных за пределами сроков, необходимых для работы приложения;
  • объединение данных, полученных через Open Client API, с данными из других источников;
  • создание баз данных, архивов, профилей пользователей, графов связей, аналитических моделей и иных производных массивов данных;
  • использование данных для рекламы, профилирования, скоринга, обучения моделей или иных целей, не связанных непосредственно с работой MAX в приложении.

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

Требования к приложению

Приложение должно корректно работать с MAX и обеспечивать совместимость с официальными приложениями и другими допущенными клиентами.

Приложение должно соответствовать технической документации и требованиям Дизайн-системы.

Без предварительного согласования с MAX нельзя:

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

Название, иконка, описание и оформление приложения не должны создавать впечатление, что приложение создано, выпущено или поддерживается MAX.

Использование App-ID

Используйте App-ID только для приложения, указанного в сертификате участника программы и одобренной заявке.

Не допускается:

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

При изменении владельца, назначения, операционной системы, архитектуры или основных функций приложения необходимо сообщить об этом MAX. В зависимости от характера изменений может потребоваться повторное рассмотрение заявки или получение нового App-ID.

Учётные данные и безопасность

App-ID используется для идентификации приложения. Секретные ключи, токены, сертификаты, данные пользовательских сессий и другие учётные данные должны храниться и использоваться в соответствии с технической документацией.

Запрещается:

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

Доступ к функциям Open Client API

Получение App-ID не означает предоставления доступа ко всем функциям Open Client API.

Для каждого приложения могут быть отдельно определены:

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

Условия доступа указываются в сертификате участника программы, технической документации или отдельных уведомлениях MAX.

Ограничения запросов

Для стабильной работы Open Client API могут устанавливаться ограничения на:

  • количество запросов за определённый период;
  • частоту отдельных операций;
  • количество одновременных подключений;
  • объём передаваемых данных;
  • количество активных сессий.

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

Запрещается обходить ограничения, в том числе распределять запросы между несколькими App-ID, приложениями, учётными записями, устройствами или иными техническими средствами.

Изменения Open Client API

Open Client API и техническая документация могут изменяться.

MAX может:

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

Разработчик должен самостоятельно следить за изменениями и своевременно обновлять приложение.

Если иной срок не указан в уведомлении или технической документации, приложение необходимо адаптировать к изменениям не позднее одного месяца со дня их публикации.

Изменения, связанные с устранением уязвимостей или угроз безопасности, могут потребовать обновления приложения в более короткий срок.

MAX не гарантирует сохранение прежних методов и обратную совместимость Open Client API.

Вкладка разработчика

Разработчик может предусмотреть в приложении отдельную вкладку со своей функциональностью.

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

Функциональность вкладки разработчика не должна:

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

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

Документация и поддержка

Полное описание интеграции доступно участникам Программы разработчиков MAX.

Подать заявку
Лицензионное соглашение