Передача интеграции в работу

Этот раздел — точка входа для разработчика сайта или backend, который будет подключать AploDelivery.

Адреса и материалы

delivery.aplo.pw обслуживает документацию. Запросы /v1/... отправляйте на базовый адрес API из таблицы.

Контакт по интеграции и доступам: Telegram @zaurrex.

Что получить перед началом

Владелец интеграции передаёт разработчику отдельным защищённым каналом API-ключ и HMAC-секрет, назначенный source, разрешённые точки и параметры вебхуков. Доступы в этот публичный портал не включены. Ограничения credentials должны соответствовать согласованному контуру интеграции.

Для проверки вызовов начните с чтения точек и меню. Отдельной публичной песочницы нет: создание заказа отправляет его на настоящую кассу. Время и точку для тестового заказа нужно согласовать до вызова POST /v1/orders.

Порядок реализации

1. Реализуйте подпись запросов, уникальный X-Request-ID и обработку ошибок. Ключи хранятся на backend; браузер не получает HMAC-секрет.
2. Получайте точки, меню и стоп-лист. Используйте ID и цены из текущего каталога; перед оформлением проверяйте адрес и доступность точки.
3. Выполняйте расчёт checkout, затем создавайте заказ с полученным calculationId и согласованным способом оплаты. При 409 price_changed покажите обновлённый расчёт гостю.
4. Сохраняйте собственный уникальный externalOrderId, повторяйте неопределённый запрос с тем же содержимым и обрабатывайте идемпотентность. HTTP 201 означает приём заказа сервисом; создание на кассе подтверждается состоянием created_verified.
5. Подключите вебхуки, проверку их подписи и опрос статуса как резервный канал. Реализуйте отмену с ожиданием подтверждённого результата.
6. Пройдите чеклист запуска и согласованный тест на выбранной кассе, включая повтор запроса и отмену.

Сертификаты и готовность точек

Сертификаты включены только на Боброво, точка 3. На реальной кассе проверены частичная и полная оплата, списание и возврат после отмены. Для остальных точек нужно отдельное включение после проверки плагина и типа оплаты. Контракт и особенности нулевой доплаты описаны в руководстве по сертификатам.

Профиль гостя GET /v1/guests/* и другие функции, отмеченные как планируемые, не входят в текущую интеграцию. Ориентируйтесь на опубликованный OpenAPI и ограничения в описаниях операций.

Что предъявить при сдаче

Передайте владельцу интеграции результаты согласованных проверок: выбранная точка, внешние и внутренние ID тестовых заказов, подтверждение создания на кассе, отсутствие дублей при повторе, результат отмены и возврата применённых средств. Проверка фискального и рабочего процесса ресторана согласуется отдельно. В отчёт не включайте секреты и персональные данные гостей.