Для разработчиков

API loyal для касс, интернет-магазинов и собственных систем

REST API с API-ключом: Ваша касса начисляет штампы и баллы, интернет-магазин передаёт заказы, а Ваша система регистрирует клиентов и погашает карты. Все эндпоинты описаны в документации.

Открыть документацию APIAPI-ключи в портале

Документация на английском, в открытом доступе без входа

Пример из документации: баллы за выручку на кассе (loyal COMMERCE)
POST /transaction/revenue
Host: api.loyal-app.de
X-API-Key: your-api-key-here
Content-Type: application/json

{ "userId": "1234567890123",
  "totalCents": 2490 }

→ 24 балла при 1 балле за евро

Что Вы подключаете через API

loyal COMMERCE: баллы за покупки онлайн и в магазине

Интернет-магазин передаёт оплаченные заказы, каждый номер заказа учитывается ровно один раз, а при отмене баллы списываются. Баллы превращаются в промокоды, которые магазин проверяет и погашает. С loyal COMMERCE в режиме выручки касса начисляет выручку в магазине на тот же бонусный счёт.

  • POST /shop/orders
  • POST /shop/orders/{orderId}/cancel
  • POST /shop/redeem
  • POST /transaction/revenue
Раздел loyal COMMERCE в документации

Подключение кассы: начислять и погашать штампы

Касса начисляет штампы, запрашивает баланс карты и погашает заполненные карты. Новых клиентов Вы регистрируете по адресу электронной почты, ответ содержит ID клиента для всех следующих запросов.

  • POST /user
  • POST /transaction
  • GET /user
  • POST /redeem
Начало работы с кассой в документации

API-ключи под Вашим управлением

Ключи Вы создаёте сами в портале, с ролью POS (касса) или ADMIN. Полный ключ показывается только один раз, затем в скрытом виде. Чтобы сменить ключ, создайте новый и отключите старый. Каждый запрос передаёт его в заголовке X-API-Key.

  • X-API-Key
Аутентификация в документации

Подключение кассы за четыре шага

  1. Создайте в портале API-ключ с ролью POS.
  2. Регистрируйте клиентов: POST /user с адресом электронной почты.
  3. Начисляйте штампы: POST /transaction.
  4. Погашайте заполненные карты: POST /redeem.
Открыть документацию APIAPI-ключи в портале