Добавление показания в ЖКХ: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
== Общие сведения == | |||
'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи. | |||
== Запрос добавления показаний == | |||
{{ProductTable-2 | |||
|title-left='''Запрос''' | |||
|title-right='''POST''' | |||
|content-left= <br>URL: https://<URL-адрес сервера>/communal/meter/indications | |||
|content-right= | |||
<syntaxhighlight> | |||
https://<URL-адрес сервера>/communal/meter/indications | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{Note|'''''Важно!'''''<br> | |||
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''acces_token'''> .|800}} | |||
{{ProductTable-2 | |||
|title-left= '''Request body''' | |||
|title-right= '''KEY/VALUE''' | |||
|content-left= <br> | |||
* '''difference''': Разница | |||
* '''meter_id''': ID счетчика | |||
* '''organization_id''': ID организации | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | |||
"difference" : <Разница> | |||
"meter_id" : <ID счетчика> | |||
"organization_id" : <ID организации> | |||
</syntaxhighlight> | |||
|}}<br> | |||
Для добавления показаний по счетчикам подготовьте POST запрос следующего вида: | Для добавления показаний по счетчикам подготовьте POST запрос следующего вида: | ||
Версия 11:45, 1 июня 2022
Общие сведения
API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.
Запрос добавления показаний
| Запрос | POST |
URL: https://<URL-адрес сервера>/communal/meter/indications |
https://<URL-адрес сервера>/communal/meter/indications |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .
| Request body | KEY/VALUE |
|
"difference" : <Разница>
"meter_id" : <ID счетчика>
"organization_id" : <ID организации>
|
Для добавления показаний по счетчикам подготовьте POST запрос следующего вида:
base URL: https://<URL-адрес сервера>/communal/meter/indications
В AUTHORIZATION укажите значение access_token согласно:
Bearer token : token <значение acces_token>
В PARAMS запроса укажите данные:
"difference" : <Разница>
"meter_id" : <ID счетчика>
"organization_id" : <ID организации>
Пример ответа на запрос
{
"indications id": <ID счетчика>
}