Контракт API-обмена MAX
Опишите систему по состояниям и операциям. Материал помогает разработчикам и заказчику одинаково понимать готовность.
Заполните пункты для своего проекта. Так первое обсуждение начнётся с конкретных требований.
01. Операция и поля
Назовите действие и обязательные параметры. Приложите обезличенный пример запроса и ответа.
02. Авторизация и роли
Определите владельца доступа и необходимые полномочия. Секреты храните отдельно от документа и клиентского кода.
03. Состояния и подтверждение
Разделите приём события, обработку и завершение. Укажите, какой сигнал разрешает показать пользователю успех.
04. Повтор и ограничения
Задайте ключ операции, допустимые повторы и лимиты. Проверьте событие, пришедшее дважды или с задержкой.
05. Ошибки и восстановление
Опишите наблюдаемый сбой и действия ответственного. Зафиксируйте способ безопасного продолжения после восстановления системы.