Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 6.23 KB

migration_guide_ru.md

File metadata and controls

89 lines (68 loc) · 6.23 KB
Raw

Migration guide

V3

Руководство по миграции с версии V2 до версии V3 Userbot API.
Добавлены следующие изменения для Userbot API:

  • Все запросы в Userbot API выполняются синхронно и сразу возвращают результат своего выполнения.
  • Удалён API-метод /request/get.
  • Изменён способ авторизации запросов к Userbot API - header-заголовок Signature удалён из проекта. Теперь для авторизации запроса необходимо передавать только header-заголовок Authorization.
  • Изменился список системных ошибок - удалена ошибка "Некорректная подпись для валидации переданных данных".
  • Запрос, отправляемый на webhook, теперь содержит только header-заголовок Authorization.
  • Добавилась возможность синхронного ответа на запрос, пришедший на ваш webhook.

Инструкция для миграции Userbot API:

  1. Поправьте все запросы к Userbot API, указав в URL запроса новую версию API (версия 3).
    Было:
    https://userbot.getcompass.com/api/v2/user/send
    Стало:
    https://userbot.getcompass.com/api/v3/user/send

  2. Удалите использование метода /request/get.

  3. Все методы из Списка методов Compass Userbot API теперь сразу возвращают результат своего выполнения.
    Замените получение request_id для методов на тот ответ, который ожидается в случае успешного выполнения запроса.

  4. Удалите передачу заголовка Signature для запросов к V3 Userbot API.
    Теперь для валидации запроса необходимо передавать один header-заголовок:
    заголовок "Authorization: bearer={токен бота}" содержит токен вашего бота.

  5. Удалите для V3 Userbot API обработку системной ошибки, которая имеет error_code = 4.

Инструкция для миграции webhook:

  1. С помощью метода webhook/setVersion установите новую версию (версия 3) webhook для своего бота.

  2. В вашем проекте, где обрабатывается запрос, пришедший на ваш webhook, удалите обработку заголовка Signature.

V2

Руководство по миграции с релизной версии до версии V2 Userbot API.
Добавлены следующие изменения:

  • Добавлена новая версия Userbot API (версия 2).
  • Изменён способ авторизации запросов к Userbot API - теперь для авторизации запросов используются header-заголовки.
  • Изменён формат параметра user_id: ранее используемый как "User-{ID}", теперь он принимает int-значение.
  • На URL-адрес установленного webhook параметр user_id также передаётся в формате int-значения.
  • Добавлены новые API-методы: webhook/setVersion и webhook/getVersion.

Инструкция для миграции:

  1. Поправьте все запросы к Userbot API, указав в URL запроса новую версию API.
    Было:
    https://userbot.getcompass.com/api/v1/user/send
    Стало:
    https://userbot.getcompass.com/api/v2/user/send

  2. Запросы к V2 Userbot API должны иметь header-заголовки:

    • заголовок "Authorization: bearer={токен бота}" содержит токен вашего бота;
    • заголовок "Signature: signature={подпись запроса}" - подпись для валидации данных запроса.

  3. В методах user/send, user/getList параметр user_id имеет формат int-значения.
    Префикс "User-" был удалён.

Пример:

{
  "user_id": 12345
}
  1. При отправке запроса на установленный webhook user_id имеет формат int-значения.
    Префикс "User-" был удалён.

Пример отправлямых на webhook данных:

{
    "group_id": "",
    "message_id": "oDT9FLRWjDOX0+4smgkCn039jKIce+NUE90zy9neDKvh6ubLMDGU/Cee5e07avTPFT/WcnAJIX...",
    "text": "/покажи список команд"
    "type": "single",
    "user_id": 12345,
}
  1. Для возможности смены версии webhook вашего бота используйте новые методы Userbot API:

Userbot release

  • Реализованы чат-боты Compass.