API

Техническая документация API

Обзор архитектуры интеграции для технических специалистов. Асинхронный протокол взаимодействия, спецификация форматов данных и механизмы обеспечения надежности.

Получить доступ Политика безопасности

Архитектурные принципы

  • Асинхронная обработка: использование паттерна Polling (202 Accepted) для работы с высоконагруженными сценариями.
  • Идемпотентность: поддержка заголовка Idempotency-Key для гарантии корректной обработки повторных запросов (retries).
  • Строгая типизация: валидация входных данных (JSON Schema) на уровне API Gateway. Основной формат payload: { "text": "..." }.
  • Rate Limiting: квотирование запросов на уровне организации (RPS/RPM) для защиты инфраструктуры.
  • Zero-Log Policy: опциональный режим работы без персистентного хранения данных (in-memory processing + TTL).

Примечание: API оптимизирован для работы с текстовыми данными. Обработка бинарных файлов (PDF, изображения) требует предварительного OCR на стороне клиента или использования специализированного эндпоинта (доступно в расширенной версии).

Спецификация и доступ

Техническая документация API открыта для разработчиков. Расширенные условия интеграции, SLA и выделенная поддержка предоставляются после подписания договора.

  • Authentication: API Key / Bearer Token аутентификация.
  • Versioning: поддержка версионирования API для обеспечения обратной совместимости.
  • Error Handling: стандартизированные коды ошибок и детализированные сообщения для отладки.
  • SDK & Examples: примеры интеграции для популярных языков программирования (Python, JavaScript/TypeScript, Go, Java).

Полная техническая документация с примерами кода доступна в разделе Документация API. Для обсуждения пилотного проекта оставьте заявку.

Рабочий процесс

  1. Инициализация (Initiate Processing): Отправка POST-запроса с полезной нагрузкой и заголовком Idempotency-Key.
  2. Подтверждение (Acknowledgement): Получение ответа 202 Accepted с task_id (идентификатором задачи).
  3. Опрос статуса (Polling): Периодический опрос статуса задачи по task_id (рекомендуемый интервал и стратегия backoff указаны в документации).
  4. Получение результата (Retrieve Result): Получение результата обработки при статусе COMPLETED.

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

Обсудить интеграцию