Документация

Полная справка по REST API и WebSocket-каналам платформы.

Quick Start

Получите API-ключ в личном кабинете и попробуйте простой запрос:

curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.nexus-flow.ru/v1/connections

Авторизация

Используем JWT-токены. Получить токен — по email/паролю:

POST /v1/auth/login
Content-Type: application/json

{
  "email": "you@example.com",
  "password": "your-password"
}

WebSocket

Для real-time-уведомлений подключайтесь к каналу с JWT:

wss://api.nexus-flow.ru/v1/ws?token=YOUR_TOKEN

Типы сообщений: connection.created, connection.updated, connection.deleted, metric.update.

Эндпоинты

GET /v1/connections

Список подключений с пагинацией через ?page и ?per_page.

POST /v1/connections

Создать новое подключение.

PATCH /v1/connections/{id}

Обновить подключение по ID.

DELETE /v1/connections/{id}

Удалить подключение.

Лимиты

На «Старт» — 60 RPM. На «Бизнес» — 300 RPM. На «Корпоративный» — без лимитов.

SDK

Готовятся официальные SDK для Python, JavaScript и Go. Следите в новостях проекта.