Руководство пользователя ИТигрис ОптимаСистемный администраторВозможности APIAPI для получения информации о количестве бонусных баллов на карте клиента

API для получения информации о количестве бонусных баллов на карте клиента

Для просмотра описания данного API, идентификатора вашей компании и ключа доступа к API зайдите в систему под пользователем с правами доступа "Системный администратор", перейдите в пункт главного меню "Настройки системы" - "Описание API"

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

Структура запроса:

https://optima.itigris.ru/client/apiBonusInfo?key=primer_c23871eaebd59650a263f23e2b0f3a71&clientCardId=ID&withExpired=true

client - идентификатор компании. В качестве идентификатора компании используется название вашего приложения Итигрис Оптима из адресной строки браузера. Например, для https://optima.itigris.ru/demo название приложения будет demo. Также идентификатор компании можно увидеть в соответствующем поле в окне "Описание внешнего API" (см. скриншот выше);
primer_c23871eaebd59650a263f23e2b0f3a71 - Ключ доступа к функционалу внешнего API. Он указан в соответствующем поле в окне "Описание внешнего API" (см. скриншот выше);
ID - номер дисконтной (бонусной) карты клиента в системе Итигрис Оптима;
withExpired - при значении true выводится детализация по срокам сгорания баллов. Если данная детализация не нужна, то не нужно указывать этот параметр, ничего не пишите после номера карты клиента

Пример запроса:

Пример приведен для приложения demo:

Нам нужно узнать количество бонусов на карте с номером 995313400001

Текст запроса:

https://optima.itigris.ru/demo/apiBonusInfo?key=c23871eaebd59650a263f23e2b0f3a71&clientCardId=995313400001&withExpired=true

Отображаемый результат:

Знаение "40" в данном случае это количество активных бонусов на карте с указанным номером, а "Tue Mar 26 23:59:59 MSK 2019" - это дата сгорания этих бонусов