Описание функциональных характеристик ПО Boxai

BoxAI (api.boxai.tech) — backend-платформа (ИИ-агрегатор), предназначенная для партнёров: партнёр создаёт продукты, подключает к ним предобученных AI-агентов и взаимодействует с ними через REST API.

Функциональные возможности:

  • Подключение AI-агентов к продуктам: для продукта хранится идентификатор агента и защищённый токен доступа (agent_access_id, agent_access_token), что позволяет использовать разные конфигурации AI-агента для разных продуктов.
  • Управление продуктами партнёров: каждый партнёр может создавать и управлять своими продуктами; у партнёров есть собственные API-ключи, а клиенты партнёра привязаны к партнёру и имеют лимиты/сроки доступа.
  • Хранение истории взаимодействий: система хранит запросы/ответы AI и связывает их с клиентом и партнёром; поддерживается дерево сообщений.
  • Безопасность и контроль доступа: проверка API-ключей партнёров, токен-авторизация, ограничение частоты запросов (rate limiting), логирование и аудит.
  • Асинхронная обработка: предусмотрены очереди/фоновые задачи для «тяжёлых» операций.
  • API-документация: интерактивная документация и OpenAPI-описание доступны по отдельным маршрутам.

Информация, необходимая для установки программного обеспечения:

Если вы пользователь (клиент партнёра), установка не требуется: доступ осуществляется по API.
Ниже — требования и шаги для развёртывания backend-сервиса на сервере.

Системные требования (сервер):

  • PHP 8.2
  • Laravel Framework 12
  • MySQL
  • Nginx
  • SSL/TLS (HTTPS)

Типовой порядок развёртывания:

  1. Подготовить сервер и установить зависимости из списка выше.
  2. Настроить подключение к MySQL и применить структуру БД (таблицы партнёров/продуктов/клиентов/сообщений и системные таблицы).
  3. Настроить Nginx и включить работу только по HTTPS (SSL/TLS).
  4. Включить обработку очередей/фоновых задач (jobs/failed_jobs/job_batches).
  5. Проверить доступность API-документации (для контроля корректности развёртывания).

Информация, необходимая для эксплуатации программного обеспечения:

Эксплуатация сервиса строится вокруг партнёров, продуктов, клиентов и обмена сообщениями:

  1. Партнёр получает API-ключ (используется для доступа к API).
  2. Партнёр создаёт продукт и указывает связанного AI-агента/настройки (agent_access_id, agent_access_token).
  3. Партнёр подключает клиентов и задаёт им лимиты и сроки доступа.
  4. Клиент отправляет сообщение в API: система выполняет проверку доступа (API-ключи/токены/лимиты), маршрутизирует запрос к AI-агенту и возвращает ответ.
  5. Запрос и ответ сохраняются в истории сообщений (для трассируемости и повторного анализа).
Где смотреть описание методов API

Если ты скажешь, это документация нужна для публичной витрины boxai.tech или именно для backend-решения api.boxai.tech, я подгоню текст под нужный объект (для витрины будет другая “Установка/Эксплуатация”, а для API — как выше).