Добавление показания в ЖКХ: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) м (Merkulov переименовал страницу CASHDESK API:Запрос добавления показания в Добавление показания в ЖКХ) |
||
| (не показано 6 промежуточных версий этого же участника) | |||
| Строка 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 <значение '''access_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"> | <syntaxhighlight lang="JSON"> | ||
"difference" : <Разница> | "difference" : <Разница> | ||
| Строка 16: | Строка 31: | ||
"organization_id" : <ID организации> | "organization_id" : <ID организации> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> | |||
'' | {{ProductTable-2 | ||
|title-left= '''Response''' | |||
|title-right= | |||
|content-left= <br> | |||
* '''indications id''': ID счетчика | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | |||
{ | { | ||
"indications id": <ID счетчика> | "indications id": <ID счетчика> | ||
} | |||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> | |||
Текущая версия на 10:37, 8 ноября 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 <значение access_token> .
| Request body | KEY/VALUE |
|
"difference" : <Разница>
"meter_id" : <ID счетчика>
"organization_id" : <ID организации>
|
| Response | |
|
{
"indications id": <ID счетчика>
}
|