Добавление показания в ЖКХ: различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
 
(не показаны 4 промежуточные версии этого же участника)
Строка 1: Строка 1:
Для добавления показаний по счетчикам подготовьте POST запрос следующего вида:
== Общие сведения ==
'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.


base URL: https://<URL-адрес сервера>/communal/meter/indications
== Запрос добавления показаний ==


{{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>


В '''AUTHORIZATION''' укажите значение access_token согласно:
{{Note|'''''Важно!'''''<br>
 
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''access_token'''> .|800}}
Bearer token : token <значение '''acces_token'''>
 


В '''PARAMS''' запроса укажите данные:


{{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">
<syntaxhighlight lang="JSON">
  {  
  {  
Строка 25: Строка 45:
  }
  }
</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


Note.svg Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .


Request body KEY/VALUE

  • difference: Разница
  • meter_id: ID счетчика
  • organization_id: ID организации
 "difference" : <Разница>
 "meter_id" : <ID счетчика>
 "organization_id" : <ID организации>



Response

  • indications id: ID счетчика
 { 
 "indications id": <ID счетчика>
 }