Amid Backend: документация интеграции

Справочник для разработчиков покупательского приложения и приложения сборщика. Документация относится к версии backend, указанной в опубликованной сборке. При работе с TEST и PROD выбирайте документацию соответствующего окружения: наличие функции в TEST не означает её доступность в PROD.

Типы, параметры и объявленные ответы HTTP генерируются из кода. Сценарии объясняют последовательность действий и поведение при сбоях. OpenAPI может не описывать все ответы middleware, внешних сервисов и инфраструктуры; учитывайте общие правила обработки ошибок.

Покрытие схем

Отчёт о покрытии фиксирует ограничения схем этой сборки. У четырёх операций успешный ответ пока не имеет объявленной схемы: POST /api/catalog/products/add-favorite/{product_id}, GET /api/catalog/version, GET /api/catalog/bootstrap/{version} и GET /api/logistics/stores/pickup/{store_id}. Это не означает отсутствие тела: добавление избранного возвращает объект со status, версия каталога — данные публикации, bootstrap — снимок витрины, магазин самовывоза — сведения о выбранном магазине. Не генерируйте для этих ответов тип «пустое тело». В описаниях некоторых ошибок picker также отсутствует полная схема тела; учитывайте общие правила ошибок.

Для ИИ и инструментов

Используйте llms.txt как оглавление, llms-full.txt для текстового содержания и OpenAPI для типов HTTP. Страницы также доступны в Markdown. Перед генерацией клиента проверяйте версию и окружение документации. Не заменяйте неизвестные поля или бизнес-правила предположениями: сверяйте автоматический справочник и соответствующий сценарий.

Открытая документация описывает основной API /api/. Она не предоставляет доступ к данным пользователей и не заменяет авторизацию. Интеграции платёжного провайдера и внешних партнёров не входят в этот справочник.


Версия: 8541d2c2730bee129f6fe6ea94c29878721733e8 · PROD. Markdown