Введение
Документ описывает функциональные характеристики программного обеспечения «LIFE POS API» (далее — ПО), а также содержит информацию, необходимую для его эксплуатации и использования при взаимодействии с внешними информационными системами.
Документ состоит из трёх разделов:
- Назначение ПО. Содержит сведения о назначении ПО и его функциональных возможностях.
- Минимальные требования. Требования, которым должно соответствовать программное обеспечение компьютера пользователя и сетевого окружения для корректной работы ПО.
- Выполнение ПО. Последовательность действий, обеспечивающих интеграцию, запуск, выполнение и завершение работы ПО; описание функций, формата и возможных вариантов команд, с помощью которых осуществляется загрузка и управление выполнением ПО, а также ответы ПО на эти команды.
Назначение ПО
Общее описание
LIFE POS API — программный интерфейс для интеграции с системой управления кассовыми операциями и обслуживания клиентов LIFE POS, предназначенный для организаций розничной торговли и всех сфер услуг, осуществляющих расчёты с использованием контрольно-кассовой техники, а также для разработчиков программного обеспечения, создающих решения на основе LIFE POS.
LIFE POS API обеспечивает удалённое взаимодействие между внешними системами пользователя и сервисами LIFE POS с использованием сетевых протоколов передачи данных.
Эксплуатационное назначение ПО
ПО предназначено для эксплуатации в составе информационных систем торговых организаций и сервисных компаний, осуществляющих:
- приём платежей;
- формирование и обработку продаж;
- управление кассовыми операциями;
- передачу данных для фискализации;
- взаимодействие с платёжной и кассовой инфраструктурой.
Эксплуатация ПО осуществляется в соответствии с требованиями Федерального закона № 54-ФЗ «О применении контрольно-кассовой техники при осуществлении расчётов в Российской Федерации».
Функциональные возможности ПО
LIFE POS API обеспечивает выполнение следующих функций:
- взаимодействие внешних систем с платформой LIFE POS;
- создание, изменение и обработка продаж;
- управление платёжными операциями;
- инициирование фискализации операций;
- получение статусов операций и продаж;
- управление торговыми точками и рабочими местами;
- управление каталогом товаров и услуг;
- передача и получение данных, связанных с расчётами;
- интеграция с внешними платёжными, учётными и информационными системами.
Функциональные возможности ПО реализуются посредством вызова программных интерфейсов (API), доступных через защищённые каналы связи.
Интерфейс ПО
LIFE POS API не имеет графического пользовательского интерфейса. Взаимодействие с ПО осуществляется программным способом — путём отправки запросов к API и получения ответов в структурированном формате.
Аутентификация осуществляется через API-ключи, хранящиеся в личном кабинете пользователя.
Основные действия пользователя
При использовании LIFE POS API пользователь выполняет следующие основные действия:
- авторизация и аутентификация при доступе к API;
- формирование запросов для создания и управления продажами;
- инициирование платёжных операций;
- получение информации о статусах операций;
- передача данных для фискализации;
- получение данных о торговых точках, рабочих местах и настройках;
- обработка ответов API и ошибок выполнения операций.
Минимальные требования
Программное обеспечение
Для корректной работы LIFE POS API требуется:
- операционная система на сервере: Linux, Windows, macOS;
- наличие доступа к сети Интернет;
- использование программных средств, поддерживающих работу с HTTP(S)-запросами;
- поддержка форматов обмена данными, используемых API.
ПО эксплуатируется на серверной инфраструктуре правообладателя и не требует установки на стороне пользователя.
Аппаратное обеспечение
Со стороны пользователя требования к аппаратному обеспечению отсутствуют. Для работы с ПО допускается использование любых вычислительных устройств, способных обеспечивать сетевое взаимодействие с API LIFE POS.
Выполнение ПО
Использование и запуск
LIFE POS API функционирует в режиме постоянной готовности к обработке запросов. Использование ПО осуществляется путём:
- формирования запроса к соответствующему API-методу;
- передачи запроса по защищённому сетевому каналу;
- получения и обработки ответа ПО.
ПО считается доступным для использования после успешного прохождения процедуры аутентификации и авторизации.
Обработка запросов
При получении запроса LIFE POS API выполняет следующие действия:
- проверяет корректность запроса;
- проверяет права доступа пользователя;
- выполняет запрошенную операцию;
- формирует ответ с результатом выполнения операции или сообщением об ошибке.
Результаты выполнения операций возвращаются в структурированном виде.
Остановка ПО
ПО функционирует на серверной стороне и не требует запуска или остановки со стороны пользователя. ПО считается остановленным, если пользователь прекращает использование программного интерфейса и не направляет запросы к серверу API.
ПО также считается остановленным в случае ограничения доступа к функциональным возможностям в соответствии с условиями предоставления сервиса.