Запросы от Twin Turbo к CarSharing

Пять эндпоинтов, которые необходимо реализовать на стороне CarSharing.

Пути — образец Названия путей в этом разделе — образец; реальные адреса и пути согласовываются индивидуально на этапе подключения и настраиваются у нас в конфигурации.

Общие правила для всех пяти вызовов

Метод — POST.
Заголовок Authorization: Bearer <ваш API-ключ> присутствует на каждом вызове — сверяйте его.
Тело запроса содержит как минимум order_id (внутренний идентификатор Twin Turbo) и external_id (ваш идентификатор, тот же что при создании заказа).

Формат бизнес-исхода

Ожидаемый формат успешного/неуспешного бизнес-исхода в теле ответа:

Успех

{ "success": true, "errorCode": "" }

Бизнес-отказ

{ "success": false, "errorCode": "человекочитаемая причина" }

HTTP-код vs бизнес-исход HTTP-код 2xx означает, что запрос принят и обработан — в том числе если success: false, это легитимный бизнес-отказ, а не сбой. Любой не-2xx трактуется как временная неполадка на вашей стороне и может быть повторён.

Методы

Метод	Когда отправляется
`book`	Заправщик берёт заказ в работу — ещё до выезда.
`unlock`	Заправщик прибыл на место.
`lock`	Заправка завершена.
`finish`	Асинхронно, вскоре после `lock` — с итоговыми цифрами.
`cancel`	Заказ отменяется после того, как был отправлен `book`.