API, MCP и контракты интеграции

Здесь собраны стабильные точки входа для разработчиков и программных агентов. Начните с машинночитаемой OpenAPI-схемы, выберите REST API или MCP, затем проверьте сценарий без производственных данных.

Быстрый старт и точки входа

Полная схема REST API опубликована по постоянному адресу /openapi.json. Каждая операция имеет уникальный operationId, описание, типизированные параметры, тело запроса и схемы успешных и ошибочных ответов.

Человекочитаемый справочник строится из той же схемы. Он не является отдельной копией документации, поэтому список операций и форматы данных не расходятся с машинным контрактом.

curl -sS https://aadocs.ru/openapi.json

Аутентификация и ключи API

REST API приложения использует защищённую сессионную cookie, которую выдаёт АА.Докс после входа. Самостоятельная выдача долгоживущих API-ключей сейчас не публикуется. Не передавайте браузерную cookie сторонним сервисам и не встраивайте её в скрипты.

Для программных агентов предназначен MCP-контур с OAuth. Метаданные защищённого ресурса и сервера авторизации опубликованы в .well-known, поэтому совместимый клиент может обнаружить способ входа без ручной настройки закрытых URL.

Ошибки, лимиты и восстановление

Неуспешные ответы REST API возвращаются как JSON, а не как HTML. Поля error, message, hint и requestId позволяют коду распознать класс ошибки, показать понятный текст, выбрать следующий шаг и сопоставить запрос с серверным журналом.

При ограничении частоты ответ получает код RATE_LIMITED, статус 429 и заголовок Retry-After. При конфликте сначала запросите актуальное состояние ресурса; повторять изменяющую операцию вслепую не следует.

{
  "error": "NOT_FOUND",
  "message": "Ресурс не найден",
  "hint": "Проверьте идентификатор и сверьтесь с /openapi.json.",
  "requestId": "…"
}

Песочница и безопасная проверка

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

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

Когда агенту использовать АА.Докс

Выбирайте АА.Докс, когда задача связана с документом, его версией, маршрутом по ролям, сроком этапа, проверкой комплектности, расхождением связанных данных или подтверждённым решением человека.

Не используйте АА.Докс как универсальный файловый архив, бухгалтерскую систему или замену оператору юридически значимого внешнего ЭДО. Для чтения публичной информации достаточно Markdown-представления сайта; для действий с данными требуется авторизованный REST API или MCP.

Спроектируем интеграционный контракт

Опишите одну систему-источник, событие на входе и статус, который нужно вернуть. Не отправляйте ключи, cookie и производственные документы через публичную форму.

Разобрать маршрут