Как загрузить JSON файл на биллинг-сервер Ajax

Обновлено

Для работы биллинга необходимо загрузить JSON файл на биллинг-сервер Ajax. Файл должен иметь определенное название и быть заполнен в соответствии с требованиями инструкции. Без этого услуга биллинга работать не будет.

Как выбрать формат и название файла?

Загружаемый файл должен:

  • Быть в формате JSON.
  • Иметь название в формате временной метки (даты создания файла). Формат записи: гггг-мм-дд-чч-мм-сс.json.
  • Быть написанным в кодировке UTF-8.

Как заполнить загружаемый файл?

Структура загружаемого JSON файла:

[
{
"hubId": "0000AF49",
"subscriptionFee": "300",
"balance": "300",
"currency": "UAH",
"blocked": "false",
"paymentDate": "2019-12-31"
},
{
….
}
]

Таблица значений полей:

Название поля Описание Значение
hubId

Идентификатор хаба.

Можно увидеть в приложении Ajax в свойствах хаба, а также на корпусе хаба под креплением SmartBracket.

8-символьное HEX значение

Например: 0000AF49

subscriptionFee Сумма ежемесячного платежа клиента

Положительные целые или дробные числа. Дробные числа записываются через точку с точностью до двух знаков.

Например: 1560.50

balance Текущий баланс счета клиента

Положительные, отрицательные, целые или дробные числа. Дробные числа записываются через точку с точностью до двух знаков.

Например: -1560.50

blocked Запрос на блокировку \ разблокировку хаба клиента Логический тип данных: true или false.
currency Тип валюты для оплаты услуг Формат записи: UAH
paymentDate Дата следующей регулярной оплаты услуг клиентом.

Дата в формате ISO 8601 (гггг-мм-дд)

Например: 2019-12-31

Все поля JSON файла должны быть заполнены! В противном случае услуга биллинга работать не будет.

Пример JSON файла: 2019-12-23-15-43-37

Как загрузить файл на биллинг-сервер Ajax?

Загрузка происходит в два этапа:

  1. Аутентификация пользователя на биллинг-сервере Ajax
  2. Загрузка файла на биллинг-сервер

Как пройти аутентификацию на биллинг-сервере Ajax

Для загрузки JSON файла необходимо пройти аутентификацию с помощью приватной части SSH-ключа, который использовался при подключении услуги биллинга.

Сделать это можно через командную строку или же с помощью FTP-клиентов (например, FileZilla).

Формат отправляемой команды:

sftp -i ssh_path [email protected]

Расшифровка:

  • sftp -i — постоянная часть, указывающая на подключение к биллинг-серверу
  • ssh_path — путь к приватной части SSH ключа
  • user_login — логин пользователя, который вы получали при подключении биллинга
  • @sftp.ajax.systems — адрес сервера (эндпоин) на который будет произведена авторизация.

Пример отправляемой команды: sftp -i C:\ssh_key [email protected]

Как загрузить файл на биллинг-сервер Ajax?

После успешной аутентификации необходимо загрузить JSON файл на биллинг-сервер Ajax. Сделать это можно через командную строку или же с помощью FTP-клиентов (например, FileZilla).

Формат отправляемой команды:

put json_path

Расшифровка:

  • put — команда загрузки файла на биллинг-сервер
  • json_path — путь к загружаемому json файлу.

Пример отправляемой команды: put C:\clients.json

В случае подключения через командную строку после успешного подключения на экране отобразится сообщение: sftp>. После этого введите команду: put json_path.

Сообщить об опечатке

Текст, который будет отправлен нашим редакторам: