Для роботи білінгу необхідно завантажити 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?
Завантаження відбувається у два етапи:
- Автентифікація користувача на білінг-сервері Ajax
- Завантаження файлу на білінг-сервер
Як пройти автентифікацію на білінг-сервері 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.