DocsДовідник API

Довідник API

Створюйте поверх BeeCastly за допомогою нашого повнофункціонального REST API. Керуйте контактами, надсилайте повідомлення, створюйте кампанії та програмно налаштовуйте веб-хуки.

Базовий URL

https://beecastly.com/api

Усі кінцеві точки API відносяться до цієї базової URL-адреси. Запити мають містити дійсний ключ API або маркер JWT.

Швидкий старт

curl -X GET https://beecastly.com/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json"

Аутентифікація

Усі запити потребують автентифікації за допомогою одного з:

Ключ API — передайте в заголовок Authorization: Bearer YOUR_API_KEY
Маркер JWT — отримано з POST /auth/login

Крім того, укажіть свій ідентифікатор орендаря: x-tenant-id: YOUR_TENANT_ID

Див. повний посібник з автентифікації →

Кінцеві точки API

Аутентифікація

Вхід, реєстрація, ключі API, токени JWT

Контакти

Операції CRUD, теги, сегменти, спеціальні поля

Повідомлення

Надсилайте WhatsApp, електронну пошту, SMS. Отримати бесіди

Кампанії

Створюйте, плануйте та відстежуйте кампанії

Веб-хуки

Підписка на події, корисне навантаження, перевірка

Боти

Сеанси ботів ШІ, повідомлення та навчальні дані

Формат відповіді

Усі відповіді відповідають узгодженому формату JSON:

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": "Error message description"
}

Обмеження швидкості

Безкоштовний рівень: 100 запитів/хв

Професійний рівень: 1000 запитів/хв

Підприємство: спеціальні обмеження

Заголовки обмеження частоти включено до кожної відповіді: X-RateLimit-Remaining