API

Ви можете підключити вашу базу даних до мобільного додатку LICHYLNYK. Ваші користувачі зможуть відправляти вам дані в кілька торкань.

З протоколом API можна ознайомитись нижче:

Опис протоколу взаємодії постачальника послуг з системою RAMS

URL для запитів тестовий і робочий:

(Наприклад https://наданий URL/send_counters/set_counter_data_lich

Від хмарної системи RAMS буде приходити POST запит на заданий URL з наступними параметрами:

Параметр Тип Опис
ulc string Унікальний ідентифікатор особистого рахунку абонента
time string Час запиту (часовий пояс — Europe/Kiev)
sign_key string Підпис запиту
app string Унікальний ідентифікатор постачальника даних
nHouse string Номер дома
nFlat string Номер квартири
nCounter string Серійний номер лічильника
dataCounter string Показники, які передає абонент
  1. * time – у форматі "2018-01-01 00:00:00"
  2. * app = lich
  3. * sign_key – результат шифрування алгоритмом sha1(ulc + time + secret_key)
  4. * secret_key – секретний ключ (надається розробником виконавця)

Результат повертається у форматі JSON.

Приклад успішної відповіді:

                [
                    {
                        "CODE": 0,
                        "MSG": "Дані успішно прийнято"
                    }
                ]
                

Приклад відповіді на помилкові запити:

                [
                    {
                        "CODE": -1,
                        "MSG": "Помилка в параметрах"
                    }
                ]
                

Коди помилок і повідомлення можна також обговорювати.