# API contract: договор интеграции

Редакция Ariol · версия 1.0 · 07.09.2026

Опишите операцию, данные, успешные и ошибочные ответы, безопасность и совместимость.

## Операция

Бизнес-цель, потребитель, поставщик, метод и путь. Например POST /orders.

## Доступ

Способ аутентификации, права роли, ограничения доступа к объектам.

## Запрос

Параметры и тело: типы, обязательность, форматы, диапазоны, допустимость null. Пример без реальных секретов.

## Успешный ответ

Статус, заголовки, схема тела и пример. Например 201 и идентификатор созданного заказа.

## Ошибки

Для каждого сценария: HTTP-статус, код ошибки, структура сообщения и действие клиента.

## Повторные запросы

Идемпотентность, таймаут, политика повторов и предотвращение дубликатов.

## Совместимость

Версия контракта, правила изменения полей, период поддержки старых клиентов.

## Приемка

Ссылка на OpenAPI-файл, валидатор, mock и позитивные / негативные контрактные тесты.

---
Учебный шаблон. Адаптируйте к внутренним регламентам и ограничениям проекта.