Перейти к содержанию

Главная страница

Добро пожаловать в документацию по BotiCord API! ``


Построение запросов

Все запросы делаются на BotiCord REST API.

URL Запросов строится следующим образом:

https://api.boticord.top/v{API_VERSION}{API_METHOD}
  • API_VERSION - Версия API
  • API_METHOD - API-метод. (расписаны в следующих разделах документации)

Версии API

BotiCord предоставляет разные версии своего API:

Версия Состояние
2 Доступна (В Разработке)
1 Доступна

Авторизация

Большинство API-методов (в том числе и в библиотеках) требуют указания API-токена авторизации. В обычных запросах он передается, как header:

Хедер Значение
Authorization API-токен

Как получить API-токен?

Для получения API-токена БОТА, первым делом, необходимо добавить вашего бота на сайт. После его верификации, Вы сможете пользоваться функционалом. Затем зайдите на страницу редактирования вашего бота.

В настройках бота спуститесь вниз, до кнопки Управление, там будет Ваш токен.

Также существует API-токен ПОЛЬЗОВАТЕЛЯ. Его получение работает через профиль пользователя:

В настройках своего профиля спуститесь вниз, до кнопки Управление, там будет Ваш токен.

А что по поводу Рейт-Лимитов?

К чему приведет превышение лимитов?

Превышение Лимитов приведет к временной блокировке доступа к ресурсу! Также учтите, что это максимальные лимиты. При частом злоупотреблении доступ может быть ограничен навсегда.

Лимиты

Путь Лимит Блокировка на
* 5/5 с 5 с
/v1/server 1/2 с 2 с
/v1/stats 1/2 с 2 с

Рекомендации от сервиса

  • Отправляйте статистику бота не чаще, чем 1 раз в 15 минут.
  • Старайтесь не доходить до превышения лимитов. (Ауф!)

Библиотеки

Для более легкого взаимодействия с сервисом BotiCord существуют библиотеки для разных языков программирования.

Вот более подробная информация о них и поддерживаемых ими возможностях BotiCord API:

Библиотека Язык Основное Сокращение ссылок Веб-Хуки API v2
boticordpy Python
BotiCord.js JS (TS)
boticordrs Rust
BotiCordJava Java
Boticord.NET .NET