Справочник API
BotLaunch API
Создавайте мощные интеграции с REST API BotLaunch. Полный доступ к ботам, пользователям, сообщениям и многому другому с подробной документацией и примерами.
Базовый URL
https://api.botlaunch.io
Версия
v1.0
Авторизация
JWT Bearer
Быстрый старт
Начните работу с API BotLaunch за несколько минут.
1. Установите или протестируйте
# Install the BotLaunch SDK
npm install @botlaunch/sdk
# Or use the REST API directly
curl -X GET "https://api.botlaunch.io/api/health" \
-H "Content-Type: application/json"bash
2. Аутентификация
// Authenticate and get an access token
const response = await fetch("https://api.botlaunch.io/api/auth/login", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
email: "your@email.com",
password: "your-password"
})
});
const { data } = await response.json();
console.log(data.accessToken);javascript
3. Выполнение API-запросов
// Make authenticated API calls
const bots = await fetch("https://api.botlaunch.io/api/bots", {
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"x-organization-id": "YOUR_ORG_ID"
}
});
const { data } = await bots.json();
console.log(data); // Array of your botsjavascript
Эндпоинты API
Ознакомьтесь с доступными эндпоинтами API, организованными по типу ресурса.
Формат ответа
Все ответы API имеют единообразную структуру JSON.
Успешный ответ
{
"data": {
"id": "bot_123",
"name": "My Bot",
"status": "active"
},
"message": "Bot retrieved successfully"
}json
Ответ с ошибкой
{
"error": "Unauthorized",
"statusCode": 401,
"message": "Invalid or expired token"
}json
Постраничный ответ
{
"data": [
{ "id": "bot_1", "name": "Bot 1" },
{ "id": "bot_2", "name": "Bot 2" }
],
"total": 25,
"page": 1,
"limit": 10
}json
Ограничение частоты запросов
Частота API-запросов ограничена для обеспечения справедливого использования и стабильности платформы.
| Тариф | Запросов/мин | Запросов/день | Пиковый лимит |
|---|---|---|---|
| Free | 60 | 1,000 | 10 |
| Starter | 300 | 10,000 | 50 |
| Professional | 1,000 | 50,000 | 100 |
| Business | 5,000 | Unlimited | 500 |
| Enterprise | Custom | Unlimited | Custom |
Заголовки ограничения частоты
Check X-RateLimit-Remaining and X-RateLimit-Reset headers in API responses to monitor your usage.