Терминалы

Через LIFE POS вы можете управлять торговыми терминалами организации. Это удобно, когда нужно обработать много терминалов. Например, добавить 50 новых и удалить 20 старых. API поддерживает два типа терминалов: банковские и СБП.

Создать терминал

Чтобы добавить новый терминал, отправьте POST-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/terminals/{type}

• base_url — адрес сервиса. Возможные значения:
  • https://api-dev.life-pos.ru — тестовый API,
  • https://api.life-pos.ru — рабочий API.
• type — тип терминала. Возможные значения:
  • bank — банковский терминал,
  • quick-payments — терминал СБП.

Описание запроса для банковского терминала Описание запроса для терминала СБП

Получить информацию о терминалах

Чтобы получить список всех терминалов организации, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/terminals/

Адреса сервиса

Описание запроса

Чтобы получить список терминалов одного типа, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/terminals/{type}

Адреса сервиса

• type — тип терминала. Возможные значения:
  • bank — банковский терминал,
  • quick-payments — терминал СБП.

Описание запроса для банковского терминала Описание запроса для терминала СБП

Данные выводятся постранично, по 20 записей на страницу. Если нужно получить данные второй страницы, возьмите из ответа значение параметра next_page_token и отправьте новый запрос, передав это значение в параметре page_token. Продолжайте до тех пор, пока параметр next_page_token не придёт пустым.

Например, вы запросили данные о сотрудниках и получили такой ответ:

“next_page_token”: “OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”,
“page_number”: 1,
“pages_total”: 2,
“items_per_page”: 20,
“items_total”: 27,

В ответе представлены только записи 1–20. Чтобы посмотреть записи с 21 по 27, отправьте новый GET-запрос, указав page_token=“OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”.

Важно

В запросе есть необязательный параметр selection. Это фильтр терминалов по их статусу. Если параметр не передан, по умолчанию используется значение alive_only, то есть в ответе придут только данные терминалов, не перенесённых в архив. Чтобы посмотреть весь список терминалов или только архивные данные, укажите значение all или archived_only соответственно.

Чтобы получить информацию о терминале по его ID без указания типа, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/terminals/*/{terminal_guid}

Адреса сервиса

Описание запроса

Чтобы получить информацию о терминале по его ID и типу, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/terminals/{type}/{terminal_guid}

Описание запроса для банковского терминала Описание запроса для терминала СБП

Изменить терминал

Чтобы внести изменения в данные терминала, отправьте PATCH-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/terminals/{type}/{terminal_guid}

Адреса сервиса

• type — тип терминала. Возможные значения:
  • bank — банковский терминал,
  • quick-payments — терминал СБП.

Описание запроса для банковского терминала Описание запроса для терминала СБП

Удалить и восстановить терминал

Вы можете отправить информацию о терминале в архив. Полностью информация не удаляется. Она исчезает из вашего интерфейса управления терминалами, но продолжает храниться на сервере LIFE POS. Её можно восстановить, если она снова понадобится.

Чтобы удалить терминал, отправьте DELETE-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/terminals/{type}/{terminal_guid}

Адреса сервиса

• type — тип терминала. Возможные значения:
  • bank — банковский терминал,
  • quick-payments — терминал СБП.

Описание запроса для банковского терминала Описание запроса для терминала СБП

Восстановить информацию об оплате можно POST-запросом:

{base_url}/v5/orgs/{org_guid}/terminals/{type}/{terminal_guid}:unarchive

Описание запроса для банковского терминала Описание запроса для терминала СБП

На этом мы закончили с терминалами. В следующей статье разберём работу с торговыми точками.