1. Домой
  2. Документация
  3. Loyalty
  4. Описание API процессинга

Описание API процессинга

С помощью этого API вы можете рассчитывать скидку, запрашивать бонусный баланс, подтверждать покупку, совершать оплату бонусными баллами, совершать возвраты и тд.
В качестве основного протокола используется HTTP, а значит, подходит для разработки на любом языке программирования, который умеет работать с HTTP-библиотеками. API процессинга является RPC и использует POST-запросы с телом в JSON формате. API всегда возвращает ответ в формате JSON.

Аутентификация

Для аутентификации запросов используется Http Bearer Auth — реализация аутентификации по токену (HTTP Bearer token). Для аутентификации с помощью токена нужно передать его в http заголовке Authorization. Например:

Authorization: Bearer FFFF70it7tzNsHddEiq0BZ0i-OU8S3xV

Токен доступа настраивается в файле конфигурации или через переменные окружения сервиса процессинга в параметре API_AUTH_TOKEN.

Ошибки

Если в процессе обработки запроса произойдет ошибка, API вернет объект ошибки и стандартный HTTP-код.

HTTP-коды, используемые в API

200 — Успешный запрос.
400 — Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API.
401 — Неверный токен доступа или отсутствует заголовок Authorization.
500 — На стороне процессинга что-то пошло не так. Результат обработки запроса неизвестен. Обратитесь к системному администратору.

Коды ошибок бизнес логики

shop_not_found — не найдена точка продаж
client_not_found — не найден клиент
card_blocked — карта заблокирована
card_already_activated — карта уже активирована
product_not_found — товар не найден
purchase_already_confirmed — покупка уже подтверждена
not_enough_bonus — не хватает бонусных баллов для оплаты
bonus_account_not_found — бонусный счёт не найден
purchase_not_found — покупка не найдена
refund_already_exists — возврат покупки с таким-же номером уже существует

Методы

purchase/calculate — Расчёт скидки и запрос бонусного баланса.

purchase/confirm — Подтверждение покупки

purchase/refund — Возврат товаров

Статьи

Материал был полезен? Да 1 Нет