Программный интерфейс приложений (API) для работы с ИС “Ferma”

Введение

В документе приводятся технические сведения о программном интерфейсе приложений (API) предоставляющем возможность регистрировать онлайн-кассы и инициировать генерацию кассовых документов посредством информационной системы (ИС) “Ferma”.

Обмен данными с онлайн-кассами происходит по протоколу HTTP с использованием зашифрованного канала (HTTPS). Данные запросов и ответов передаются в виде структуры JSON. Вне зависимости от наличия ошибок в данных, обязательным условием успешного выполнения запроса является ответ с кодом 200 согласно протоколу HTTP.

Ниже описаны запросы HTTP, которыми реализуются функции API по работе с онлайн-кассами.

1. Общий вид запроса и ответа в процессеиспользования API

Кодировка, используемая в запросах и ответах – UTF-8. Запросы выполняются методом POST, параметры запроса передаются в JSON структуре, передаваемой в блоке данных запроса.

Ответы выдаются сервером в формате JSON и, в случае успешности ответа согласно его заголовку (код ответа по протоколу HTTP равен 200), данные имеют следующий обобщенный вид:

Здесь ключу "Data" соответствует пустое поле; ключ введен в структуру для обеспечения единообразия запросов в ИС “Ferma”; параметр "Status" – состояние обработки запроса – в данном случае имеет значение "Success" (запрос обработан успешно).

В случае неуспешности ответа (код ответа по протоколу HTTP не равен 200) данные имеют следующий обобщенный вид:

Здесь ключу "Error" соответствует объект, в котором присутствуют код и сообщение об ошибке; код ошибки всегда отличен от 0; на месте строки"string" будет сообщение об ошибке, возникшей при обработке переданных данных. параметр "Status" в данном случае имеет значение "Failed" (обработка запроса не удалась).

2. Авторизация через AuthToken

Возможность множественных обращений к ИС “Ferma” после одной авторизации без использования механизма Cookies реализуется с помощью механизма AuthToken: после авторизации с передачей имени и пароля система возвращает код авторизации – строку символов, которая используется, как параметр авторизации при обращении к соответствующему личному кабинету (ЛК). HTTP-запрос авторизации, передающий имя пользователя и пароль в формате JSON выглядит следующим образом:

В данном запросе присутствуют примеры значений: передаваемое имя пользователя – "12345" и пароль – "56789"; они задаются как значения в JSON-структуре внутри запроса с ключами "Login" и "Password" соответственно. В ответ на данный запрос будет получен ответ по протоколу HTTP, который в случае успешной авторизации будет иметь код равный 200 и содержать структуру, подобную следующей (приведены примеры значений):

Здесь с ключом "AuthToken" – код авторизации: строка символов AuthToken, представляет собой 32-значную последовательность шестнадцатеричных цифр, используемую для повторной аутентификации, а ключ "ExpirationDateUtc" – строка, описывающая момент времени (дату и время в формате UTC), до которого будет действовать данный код авторизации.

Момент времени задается в формате "ГГГГ-ММ-ДДTчч:мм:сс"; здесь

В случае проблем с авторизацией (код ответа по протоколу HTTP будет равен 403) данные будут отсутствовать, JSON-структура будет пустой (будет иметь вид «{}»). Полученный код авторизации используется в виде дополнительного параметра в запросах документов для сверки, где необходима авторизация. Пример запроса с использованием кода авторизации:

здесь Code1 – действующий код авторизации, полученный в результате запроса авторизации.

3. HTTP-запросы к ИС “Ferma” для работыс онлайн-кассами

3.1. Формирование кассового чека

Вид запроса: POST /api/kkt/cloud/receipt. Тело запроса представляет собой структуру JSON, содержащую необходимые параметры и имеющую следующий обобщенный вид:

Параметры структуры приведены в таблице 2.

Таблица 2. Параметры структуры данных запроса на формирование кассового чека

Все вышеуказанные поля являются необходимыми, за исключением полей Email и Phone, здесь необходимым является наличие хотя бы одного из них.

В случае успеха ответ имеет следующий вид:

Параметры структуры «Data» приведены в таблице 3.

Таблица 3. Параметры структуры данных запроса на формирование кассового чека

3.1.1. Возможные значения вида вычисляемого НДС (поле “Vat”)

• "Vat10" — налог на добавленную стоимость (НДС) 10%;
• "Vat18" — НДС 18%;
• "Vat20" — НДС 20%;
• "Vat0" — НДС 0%;
• "VatNo" — НДС не облагается;
• "CalculatedVat10110" — вычисленный НДС 10% от 110% суммы;
• "CalculatedVat18118" — вычисленный НДС 18% от 118% суммы;
• "CalculatedVat20120" — вычисленный НДС 20% от 120% суммы.

3.1.2. Типы формируемых чеков

• "Income" — получение денежных средств от покупателя;
• "IncomeReturn" — возврат денежных средств, полученных от покупателя;
• "IncomePrepayment" — авансовый платеж от покупателя;
• "IncomeReturnPrepayment" — возврат аванса;
• "IncomeCorrection" — чек коррекции;
• "Expense" — выдача денежных средств покупателю;
• "ExpenseReturn" — возврат денежных средств, выданных покупателю.

3.1.3. Возможные значения типа налогообложения(поле “TaxationSystem”)

• "Common" или "0" — общая система налогообложения;
• "SimpleIn" или "1" — упрощенная система налогообложения (доход);
• "SimpleInOut" или "2" — упрощенная система налогообложения (доход минус расход);
• "Unified" или "3" — единый налог на вмененный доход;
• "UnifiedAgricultural" или "4" — единый сельскохозяйственный налог;
• "Patent" или "5" — патентная система налогообложения.

Внимание! Возможные (корректные) значения типа налогообложения ограничиваются значениями, отмеченными, как разрешенные при регистрации кассы. Для того, чтобы изменить список допустимых типов налогообложения, необходимо произвести перерегистрацию кассы.

3.1.4. Условия успешного формирования чека

Сформированный чек будет считаться корректным, если он соответствует следующим условиям:

• в чеке есть хотя бы одна позиция;
• цена и сумма по позиции неотрицательная;
• общая сумма всех позиций больше нуля;
• входная строка наименования товара длиной не более 128 символов, прочие символы будут обрезаны;
• указанная система налогообложения должна совпадать с одним из вариантов, зарегистрированных в ККТ;
• числовые значения переданы с точностью не более двух знаков после запятой;
• передан ИНН, если он требуется в документации.

3.1.5. Возможные ошибки

• «Не найдены данные компании с ИНН Y», где Y — значение ИНН;
• «Доступ запрещен»;
• «Ошибка создания чека: X», где X — сообщение сервера системы;
• «Превышено максимальное количество обращений», максимальное количество сообщений рассчитывается по максимальной допустимой нагрузке на кассу: один чек в 3 секунды.

3.1.6. Возможные значения Признака способа расчета (поле “PaymentMethod”)

• 1 — предоплата 100%;
• 2 — предоплата;
• 3 — аванс;
• 4 — полный расчет;
• 5 — частичный расчет;
• 6 — передача в кредит;
• 7 — оплата кредита.

3.1.7. Возможные значения Типа оплаты (поле “PaymentType”)

• 0 — наличными;
• 1 — безналичными;
• 2 — предварительная оплата (аванс);
• 3 — предварительная оплата (кредит);
• 4 — иная форма оплаты.

3.2. Проверка статуса кассового чека

Важно! Информация о статусе имеет срок годности (сутки), после которого перестает быть доступна. После истечения этого срока, при попытке запроса статуса вернется ошибка «Чек не найден». Это означает, что информация по данному чеку удалена из оперативной памяти для освобождения ресурсов, но она остается доступна при помощи запроса реестра кассовых чеков (3.3).

Вид запроса: POST /api/kkt/cloud/status. Тело запроса представляет собой структуру JSON, содержащую необходимые параметры и имеющую следующий обобщенный вид:

Параметры структуры приведены в таблице 3.

Таблица 3. Параметры структуры данных запроса статуса кассового чека

В случае успеха ответ имеет следующий вид:

Параметры структур Data и Device приведены соответственно в таблицах 3.1 и 3.2.

Таблица 3.1 Параметры структуры данных информации о кассовом чеке

Возможные значения:

• запрос на чек принят ИС «Ferma»:

• чек сформирован на кассе:

• чек передан в ОФД:

3.3. Запрос реестра кассовых чеков

Вид запроса: POST /api/kkt/cloud/list. Тело запроса представляет собой структуру JSON, содержащую необходимые параметры и имеющую следующий обобщенный вид:

В случае наличия не пустого параметра "ReceiptId" остальные могут отсутствовать; в случае наличия не пустых параметров "StartDateUtc" и "EndDateUtc" остальные могут отсутствовать; в случае наличия не пустых параметров "StartDateLocal" и "EndDateLocal" остальные могут отсутствовать. Параметры структуры приведены в таблице 4.

Таблица 4. Параметры структуры данных запроса статуса кассового чека

В случае успеха ответ имеет следующий вид:

Параметры структуры элементов массива «Data» приведены в таблице 4.1.

Таблица 4.1 Параметры структуры данных запроса на формирование кассового чека

4. Коды ошибок

5. История изменений

Версия 2.0

Выпущена 24 августа 2018 г.

Первая регистрируемая версия документа.

Версия 2.1

Выпущена 14 ноября 2018 г.

• исправлены ошибки по тексту предыдущей версии документа;
• добавлена информация о новым значениях констант типов НДС.

Версия 2.2

Выпущена 17 января 2019 г.

• исправлена ошибка в тексте предыдущей версии документа: замена строки «FPD» на «FDP» в примерах структур данных.

Версия 2.3

Добавлена 28 января 2019 г.

• добавлена информация в соответствии с изменениями в структуре данных CustomerReceipts.

Версия 2.6

Добавлена 04 апреля 2019 г.

• исправлена ошибка в тексте предыдущей версии документа: замена в таблице 3.2 «FPN» на «FDP»;
• исправлена ошибка в тексте предыдущей версии документа: удаление лишней запятой в строке ответа при запросе кассового чека.