SetKit ◾️ Работа с сервисом SetKit через API

Сохранить/Добавить мягкий чек

Метод: PUT или POST

Адресация: http://{IP-адрес службы SetKit}:8081/set-kit/softcheques/{ШК мягкого чека}

Request Content-Types: application/json

Описание:

ВАЖНО

Существует 2 стратегии генерации номера (guid) мягкого чека:
1. Номер МЧ (guid) генерируется в SetKit на POST-запрос. Он будет сформирован на основании настроек:
- префикс
- длина МЧ

2. Номер МЧ (guid) присылает внешняя система. При этом необходимо использовать PUT-запрос

Пример создания мягкого чека в Postman:

Получить мягкий чек в определённом статусе по его guid

Метод: GET

Адресация: http://{IP-адрес службы SetKit}:8081/set-kit/softcheques/{guid}/status/{status}

Request Content-Types: application/json

Описание: возвращает чек с указанным guid

Код ответа: 200 (Чек найден)

Пример работы с запросом чека по статусу в Postman

Получить мягкий чек по guid

Метод: GET

Адресация: http://{IP-адрес службы SetKit}:8081/set-kit/softcheques/{guid}/

Request Content-Types: application/json

Описание: возвращает чек с указанным guid

Код ответа: 200 (Чек найден)

Пример работы с запросом чека по статусу в Postman:

Обновить чек - изменить данные чека

Метод: PUT

Адресация: http://{IP-адрес службы SetKit}:8081/set-kit/softcheques/{guid}/

Request Content-Types: application/json

Описание: поиск в хранилище локальной версии чека по guid и обновление записи. Если чека не существует, то произойдет его создание.

Внимание!

Обновление данных, полностью затирает существующие данные мягкого чека. То есть, необходимо отсылать не изменения чека, а полную измененную версию каждый раз.

Пример работы с запросом в Postman:

Удалить мягкий чек

Метод: DELETE

Адресация: http://{IP-адрес службы SetKit}:8081/set-kit/softcheques/{guid}/

Request Content-Types: application/json

Описание: переводит чек в статус deleted, и после этого его невозможно получить извне. После удаления, guid можно использовать для другого чека.

Код ответа: 200 (Чек найден)

Получить мягкий чек по номеру телефону

Метод: GET

Адресация: http://172.29.16.51:8081/set-kit/softcheques?phone=79991112233&status=READY_TO_PAYMENT

Request Content-Types: application/json

Описание: возвращает чек с указанным номером мобильного телефона phone

Код ответа: 200 (Чек найден)

Пример работы с запросом чека по статусу в Postman: