- Что такое API?
- Ссылка на документацию
- Что нужно для работы?
- Какие задачи можно решить при помощи API
- Ошибки при передаче запроса
- Дополнительная информация по API
API — это конструктор, в котором есть набор деталей (функций, методов) и правил их использования. Из этих деталей Вы можете построить собственное приложение. При работе через API приложение отправляет запрос к серверу и получает ответ, содержащий запрошенные данные. API предоставляет возможность автоматизировать процессы.
Был разработан API -мануал, который содержит в себе несколько вариантов решения различных задач (ссылка на API-мануал доступна всем клиентам в ЛК > Настройки - Разработчикам - Документация)
Ссылка на API находится в ЛК LIFE PAY - Настройки - Разработчикам.
Или можно перейти по ссылке.
Потребуется:
- оплаченный тариф Облачной Фискализации
- логин - номер телефона, который был указан в ЛК LIFE PAY при регистрации
- API ключ - находится в ЛК LIFE PAY - Настройки - Разработчикам.
Какие задачи можно решить при помощи API?
- Оповещение о транзакции
- Транзакции
- Интеграция приложений
- Выставление счета
- Каталог
- Заказы
- Удаленная фискализация
Благодаря этому разделу, вы можете автоматизировать обработку платежей в своей системе. Система будет получать статус платежа от LIFE PAY не привязанный ни к какому заказу. Просто оповещение о факте проведения транзакции.
Для того, чтобы вы могли успешно использовать данный сервис вам необходимо предоставить нам адрес URL (способный обрабатывать подобные запросы), который наши разработчики пропишут в нашей базе. После того, как URL будет внесен в нашу базу, после проведения оплаты наша система будет посылать сообщение о статусе транзакции в вашу систему.
Сервер будет повторять запрос через определенные промежутки времени до получения http кода 200 (код 200 это подтверждение получения информации от вашего сервера), или до подхода к максимальному лимиту на количество запросов по данному уведомлению. Промежутки повтора запроса: 1 минута, 3 минуты, 5 минут, 10 минут, далее – один раз в час. Всего допустимо не более 10 попыток отправки уведомления
Версия 2.0 - актуальная, которую могут использовать все желающие. Главное требование это наличие программиста, технического специалиста со стороны клиента (настройка производится со стороны клиента самостоятельно).
В этом разделе информация о том, как получить список транзакций включающий в себя определенные требования. Например можете выгрузить транзакции за определенную дату или по конкретному сотруднику.
Передача данных осуществляется открытием URL со схемой lifepay:// из браузера, либо нативного приложения Android. Этот функционал может быть полезен, если заказы ведутся в собственном приложении курьера, а оплату необходимо провести через LIFE PAY. Приложение LIFE PAY оповещает запустившее его приложение о факте успешной оплаты и передаёт данные по оплате, что позволяет закрыть заказ в курьерском приложении. Как правило это может быть удобно службам такси и курьерским доставкам.
LIFE PAY позволяет вам выставить в своей системе счет на оплату и отправить покупателю на номер телефона или email-адрес. Данный функционал работает как мобильный интернет эквайринг, т.е покупатель получив ссылку попадает на страницу оплаты, где вводит данные своей карты. Проверить успешность оплаты вы можете посмотрев её статус в Личном Кабинете LIFE PAY, либо отдельным запросом. Сервис полезен владельцам собственных CRM-систем, сервисов и интернет-магазинов, так как позволяет принять платеж без необходимости использовать терминал.
Для использования данного сервиса, необходимо подключение интернет-эквайринга.
Если Вы имеете потребность загрузить (импортировать) в личный кабинет уже существующий каталог и товары из сторонней системы, вы можете сделать это через API-запрос. Для этого используйте информацию из раздела “Каталог”. Каталог, который уже импортирован в личный кабинет, можно редактировать, добавлять/удалять позиции, менять стоимость и другие параметры товара и категорий. Функционал экспорта (выгрузки) каталога из нашего личного кабинета, к сожалению, пока не доступен.
LIFE PAY позволяет удаленно фискализировать продажи без необходимости во взаимодействии с принтером на месте продажи, либо собирать продажи из нескольких источников для печати на одном принтер
Функционал API по удаленной фискализации позволяет: удаленно фискализировать продажи, отправлять чек на печать, удаленно создать чек-коррекции (в случае проведения ошибочных позиций), открывать/закрывать смену, формировать промежуточный X-отчет, формировать уведомление на заданный URL
|
Ошибка |
Ответ |
|---|---|
|
Ошибка 6080 cloud print is not allowed / при настройке удаленной фискализации |
У Вас отключена удаленная фискализация. Обратитесь в службу поддержки по вопросу активации данного сервиса. |
|
Ошибка 429 / ошибка при загрузке каталога |
Вы слишком часто отправляете запрос. Необходимо отправлять запросы не более 3-х в минуту |
|
Ошибка 6010 |
Указан неверный apikey (из личного кабинета) или логин / Проверить логин, скопировать apikey из ЛК (Настройки - Разработчикам) |
|
Ошибка 3896 |
Сумма не наличных оплат превышает сумму чека (сумма позиций одна, а в запросе передается, что оплачено картой больше). Необходимо передавать правильные данные для фискализации. |
|
Ошибка 3975 Некорректное значение параметров команды ФН |
При ее появлении: 1. Проверить СНО . 2. Проверить запрос, который отправляется на сервер Как правило, данная ошибка связана с тем, что передается запрос на фискализацию с сно ОБЩ а ФН на 36 мес.
Особенности для YCLIENTS: У себя в личном кабинете можете редактировать товары\услуги, которые продаете, и можете задать НДС и СНО для определенной позиции. Если данная ошибка встретилась на YCLIENTS, то вам нужно в ЛК YCLIENTS проверить верно ли выставлен НДС и СНО для позиций из чека с ошибкой.  |
|
Ошибки при импорте каталога |
|
|
6050 - Неверная структура данных |
Необходимо проверить структуру данных на соответствие документации |
|
6051 - Не указан строковый идентификатор категории/товара в системе клиента |
Проверьте корректность заполнения параметра id Значение этого параметра будет передано в поле ext_id в сервисе уведомления о транзакции. В рамках категорий и товаров значение этого параметра должно быть уникально (как в примерах xml). |
|
6052 - Не указано наименование категории/товара |
Проверьте корректность заполнения параметра name |
|
6053 - Необходимо указать торговую точку |
Проверьте корректность заполнения параметра trade_point_uuid |
|
6054 - Каталог/товары уже существуют |
Проверьте корректность заполнения параметра force *(для перезаписи необходимо указать параметр |
|
6055 - Ошибка сохранения каталога |
Сопровождаются описанием в ответе на запрос (пример: "message": "Error on save product with id = '2': Image Url не является правильным) |
|
6056 - Ошибка сохранения товара |
Сопровождаются описанием в ответе на запрос (пример: "message": "Error on save product with id = '2': Image Url не является правильным)ext_id - идентификатор заказа во внешней системе (если заказ передан из сторонней системы); |
Система автоматически вернет эти параметры после транзакции.
Дополнительная информация по API (при использовании сервиса LIFE PAY Касса)
В статус paid заказ переходит автоматически при оплате через наше приложение. Передавать этот статус по АПИ не обязательно.
По кассовому приложению: В Х и Z отчетах в разделе Приход/Расход указывается сумма, которая была учтена ККТ при регистрации продажи/возврата, фискализирована и отправлена в ОФД. Это сумма всех чеков за смену.
Также есть раздел Приходы/Расходы - это позиционные счетчики товаров в чеках. ККТ ведет подсчет количества позиций в чеке, при этом не ведется учет кол-ва товаров/услуг в одной позиции.
number
Отображение слова “Агент” в чеке ОФД
Тег 1222 (Признак агента по предмету расчета) в электронном чеке (в ОФД) не размещается в силу закона, поэтому для конкретной позиции ОФД его не указывает .
А вот тег 1057 (признак агента) всегда обязателен к размещению для всего документа, и мы указываем его в электронном чеке
Как бить чеки аванса и предоплаты по АПИ?
При дистанционных способах расчета, когда момент оплаты товара и его отправка происходят в разное время, пользователь ККТ должен сформировать два чека:
-
1 чек:
При поступлении денежных средств с признаком способа расчета «ПРЕДОПЛАТА», «ПРЕДОПЛАТА 100%» или «АВАНС» и способом оплаты «Безналичными» или «Наличными» -
2 чек:
При отгрузке товара (при передаче в службу доставки) с признаком способа расчета «ПОЛНЫЙ РАСЧЕТ» и способом оплаты «Аванс».
Передача тегов API на примере Предоплата 100%:
-
1 чек:
Признак способа расчета type "1 - Полная предварительная оплата до момента передачи предмета расчета;"
Сумма, оплаченная клиентом по карте card_amount -
2 чек:
Признак способа расчета. type "4 - Полная оплата, в том числе с учетом аванса (предварительной оплаты) в момент передачи предмета расчета;"
Сумма, внесенная авансом prepayment_amount