AploDelivery Partner API — портал разработчика
Версия API: v2. Документация обновлена 16.10.2026. Начните с передачи интеграции в работу, затем используйте интерактивный OpenAPI и машиночитаемый контракт. Базовый адрес API — https://api.aplosnab.ru.
Портал предназначен для backend-разработчика партнёра, который интегрирует свой сервис с AploDelivery. Первый и пока единственный подключённый партнёр — сайт ВиЛ (api.vkusilosos.ru, source: website). Всё, что описано на этих страницах, относится к серверной интеграции: браузер и мобильное приложение никогда не обращаются к AploDelivery напрямую, ключи и HMAC-секрет живут только на вашем backend.
С чего начать
Разработчику: передача интеграции в работу — адреса, доступы, порядок реализации и критерии сдачи.
- Быстрый старт — первый подписанный запрос за 10 минут, curl и Go.
- Аутентификация и подпись запроса — точная схема HMAC-подписи с тестовым вектором.
- Жизненный цикл заказа — состояния заказа, статусы доставки, диаграмма.
- Чеклист перед запуском в проде — что проверить перед первым боевым заказом.
Что умеет API сегодня (v1, живой контракт)
AploDelivery принимает канонический заказ от партнёрского backend и передаёт его в ресторанный контур iiko через плагин на кассе. Эндпоинты, доступные партнёру:
| Метод и путь | Назначение | Руководство |
|---|---|---|
POST /v1/orders | Создать заказ (идемпотентно) | Быстрый старт, Идемпотентность |
GET /v1/orders?externalOrderId= | Найти заказ по своему ID | Жизненный цикл заказа |
GET /v1/orders/{id}?source= | Прочитать статус заказа по UUID | Жизненный цикл заказа |
POST /v1/orders/{id}/cancel | Запросить отмену заказа | Отмена заказа |
GET /v1/points | Точки, доступные вашим credentials | Быстрый старт |
GET /v1/points/{pointId}/products | Активные товарные маппинги точки | Быстрый старт |
POST /v1/addresses/check | Сверить адрес со словарём улиц точки | Быстрый старт |
GET /health/live, GET /health/ready | Публичные health-проверки сервиса | SLA |
Обновления состояния и статуса доставки приходят вебхуками — см. Вебхуки; опрос (GET /v1/orders/{id}) остаётся резервным каналом.
Что не входит в партнёрский контур
POST /operator/api/*— это внутренний UI колл-центра Aplo (сессия по cookie, AploKey SSO), не часть партнёрского протокола и не документируется на этом портале.POST /v1/plugin/*иPUT /v1/plugin/streets— протокол claim/ACK между AploDelivery и плагином iikoFront на кассе. Партнёрский backend их не вызывает; они упоминаются в руководствах только там, где нужно объяснить, откуда берутся статусы и вебхуки.
Что задеплоено в v2 (2026-10-03)
Меню и стоп-лист с iiko как источником истины, метаданные точек, зоны доставки, checkout-прайсинг, онлайн-оплата и лояльность AploCard работают на проде https://api.aplosnab.ru:
GET /v1/points/{pointId}/menu,GET /v1/points/{pointId}/stop-list,GET /v1/catalog/revision— меню и стоп-лист;GET /v1/points(расширение полями адреса/расписания),GET /v1/points/{pointId}/status— метаданные точек;POST /v1/delivery/resolve,GET /v1/points/{pointId}/delivery-zones— зоны доставки;POST /v1/checkout/calculate, расширениеPOST /v1/ordersполемpayment(в т.ч.method: online→ предоплата «Оплата онлайн» на кассе) — checkout и онлайн-оплата;bonusToSpend— списание ВкусКоинов (на кассе вторая строка оплаты «Вкускоин»);coupon— промокоды (скидка программы лояльности на уровне заказа);- комментарий к заказу доставляется на кассу;
- сертификаты — включены на Боброво (точка
3), на кассе проверены частичная и полная оплата и возврат после отмены.
Что запланировано (ещё недоступно)
GET /v1/guests/{phone}/loyalty,GET /v1/guests/{phone}/orders,GET /v1/guests/{phone}/addresses— профиль гостя;GET /v1/status(freshness синхронизации с iiko), полный набор лимитов запросов из спецификации §7;
Разделы портала
| Раздел | Страницы |
|---|---|
| Руководства | Быстрый старт · Аутентификация · Идемпотентность · Жизненный цикл заказа · Отмена заказа · Вебхуки · Справочник ошибок · Чеклист перед запуском |
| Политики | Версионирование · SLA · Безопасность · Поддержка |
| История | Changelog |
SDK и справочник API
- Машиночитаемый контракт:
openapi.yaml(OpenAPI 3.1). При расхождении между этим порталом иopenapi.yaml— веренopenapi.yaml, сообщите об этом по каналу из Поддержки. - Postman-коллекция, sandbox с POS-симулятором и doc-тесты — запланированы (v2 §9), пока недоступны.
Соглашения портала
- Все примеры кода соответствуют
openapi.yamlи реальному Go-коду сервиса на дату публикации версии (см. Changelog). - Неизвестный или ещё не согласованный факт помечен как
<уточняется>— это не опечатка, а явная метка отсутствующей информации. - Деньги — целые копейки (
amountMinor+currency). Время — RFC 3339 со смещением; деловые даты и время сервиса —Europe/Moscow.