Перейти на сайт

Описание UserAPI ПО МТС Линк on-premise. Чаты

UserAPI для Чатов

UserAPI

Важно!

Для работы с ПО МТС Линк Чаты по API нужно авторизоваться в Чатах хотя бы один раз.


Ключ

Для работы с UserAPI потребуется ключ авторизации и перечень запросов (методов).

Ключ — это авторизационный токен. Он доступен в подразделе «API/Webhooks» раздела «Бизнес» личного кабинета МТС Линк. Во всех запросах он передается в параметре x-auth-token.

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

Для добавления ключа необходимо в разделе «Бизнес» личного кабинета МТС Линк перейти в подраздел «API/Webhooks» на вкладку «API» и нажать на кнопку «Добавить»:

Далее в поле «Интеграции» выбрать из выпадающего списка нужную (если нет подходящего варианта, необходимо выбрать «Другое»), в поле «Доступы» в выпадающем списке отметить нужные варианты.


Важно! Единовременно может храниться не более 20 ключей.


Набор выбранных доступов можно изменить в любое время без необходимости удалять или обновлять ключ. Для этого нужно нажать на троеточие справа от интеграции и выбрать «Редактировать». Там же можно удалить интеграцию:

Правила использования ключа

  • Ключ необходимо указывать в каждом запросе.
  • По ключу происходит авторизация, и платформа разрешает выполнить этот запрос.
  • Ключ принадлежит Владельцу аккаунта на платформе, и все запросы выполняются от его имени.
  • При работе с модулем «Организация» применяется ключ ее Создателя и распространяется на всех сотрудников.

Ограничения

Количество запросов к пользовательскому API не может превышать двух в секунду.

При получении ответа

{"error":{"code":429, "message": "I only allow 2 requests per second. Try again."}}

следует снизить частоту запросов.

Ошибки

Общие ошибки:

  • 400 — не переданы или переданы в неверном формате обязательные параметры;
  • 401 — не передан или передан некорректный заголовок x-auth-token;
  • 403 — переданный x-auth-token неактивен или не существует;
  • 404 — передаваемая в заголовке сущность не найдена для этой Организации.

Методы. Чаты

Важно!

Во всех методах и примерах запросов часть значения URL «userapi.mts-link.ru/v3» (или вариации) должна быть заменена на «chats.example.ru/api/userapi», где «chats.example.ru» задается в соответствии с установочными настройками доменов (подробнее см. в «Руководстве по установке ПО МТС Линк on-premise. Чаты»).


Например:

URL: https://userapi.mts-link.ru/v3/chats/organization/members

примет вид

URL: https://chats.example.ru/api/userapi/chats/organization/members



👆 На этом пока всё