Обзор API ReMarked

API ReMarked предназначено для доступа к процессингу программ лояльности (ПЛ) на базе ReMarked. Через него кассовые системы (iiko, R-Keeper) и внешние сервисы взаимодействуют с процессингом: получают данные о госте, считают скидки и бонусы, проводят и подтверждают транзакции, синхронизируют меню.

Версии API

Текущая версия Loyalty API v2 — 2.12 (по спецификации OpenAPI ReMarked Loyalty API v2).

Базовые принципы

• Транспорт: HTTP(S). Большинство методов v2 — POST, тело в формате JSON. Часть методов v1 работают по протоколу JSON-RPC (method, params, id).
• Авторизация: Bearer Token в заголовке Authorization: Bearer <token>. В v1 токен можно передать также как параметр в теле запроса.
  • Токены и ключи доступа в документацию не выносятся (доступы хранятся во внутренней базе знаний, раздел 18).
• Идентификатор запроса: заголовок X-Request-Id — уникальный идентификатор обращения. Используется для трассировки запроса в логах и при обращении к разработчикам.
• Идентификация поинта: числовой код заведения (point). Для сетевых клиентов часто используется общий поинт сети.
• Формат статусов: код 200 OK означает, что запрос принят, но внутри JSON может присутствовать "status":"error" с полями code/message/mes. Всегда проверять тело ответа, а не только HTTP-код.

Структура раздела «Справочник API»

Документация (внешние ссылки)