CASHDESK API:Запрос получения полной информации о клиенте через API: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
(не показано 14 промежуточных версий этого же участника) | |||
Строка 1: | Строка 1: | ||
Для | == Общие сведения == | ||
'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи. | |||
== Запрос получения информации о клиенте == | |||
{{ProductTable-2 | |||
|title-left='''Запрос''' | |||
|title-right='''GET''' | |||
|content-left= <br>URL: https://<URL-адрес сервера>/communal/client/details | |||
|content-right= | |||
<syntaxhighlight> | |||
https://<URL-адрес сервера>/communal/client/details | |||
</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> | |||
* '''id''': Id клиента | |||
* '''organization_id''': Id организации | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
"id": <id клиента>, | "id": <id клиента>, | ||
"organization_id ": <id организации> | "organization_id ": <id организации> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> | |||
'' | {{ProductTable-2 | ||
|title-left= '''Response''' | |||
|title-right= | |||
|content-left= <br> | |||
* '''apartment''': Номер квартиры клиента | |||
* '''address''': Адрес клиента (населенный пункт, улица, дом) | |||
* '''building''': Корпус | |||
* '''feeder''': Фидер | |||
* '''house''': Дом | |||
* '''id''': ID клиента в Расчетном центре (РЦ) | |||
* '''livingSpace''': Жилая площадь квартиры клиента | |||
* '''name''': ФИО Клиента | |||
* '''numberOfRooms''': Количество комнат в квартире клиента | |||
* '''personalAccount''': Лицевой счет | |||
* '''phoneNumber''': Номер телефона | |||
* '''''services''''': | |||
** '''accrual''': Сумма начислений за текущий период | |||
** '''balance''': Сальдо на конец периода | |||
** '''beginningBalance''': Сальдо на начало текущего периода | |||
** '''id''': ID услуги в Расчетном центре (РЦ) | |||
** '''''meters''''': ''Счетчики'' | |||
*** '''id''': ID счетчика в Расчетном центре (РЦ) | |||
*** '''''indications''''': ''Показания'' | |||
**** '''date''': Дата и время передачи показания в формате Unix Time | |||
**** '''id''': ID переданного показания в Расчетный центр (РЦ) | |||
**** '''meterId''': ID счетчика | |||
**** '''value''': Значение преданного показания | |||
*** '''number''': Номер счетчика | |||
*** '''seal''': Номер пломбы | |||
*** '''serviceId''': ID услуги в Расчетном центре (РЦ) | |||
*** '''type''': Полное наименование счетчика | |||
** '''name''': Наименование услуги в Расчетном центре (РЦ) | |||
** '''payment''': Сумма оплаты за текущий период | |||
** '''recalculation''': Перерасчет за текущий период | |||
** '''status''': Статус клиента отключен(0)/подключен(1) | |||
* '''substation''': Номер подстанции | |||
* '''town''': Населенный пункт клиента | |||
* '''transformer''': Номер трансформатора | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
{ | |||
"building": "string", | "apartment": 0, | ||
"feeder": "string", | "address": "string", | ||
"house": "string", | "building": "string", | ||
"id": <ID клиента>, | "feeder": "string", | ||
"name": "string", | "house": "string", | ||
"personalAccount": "string", | "id": 0, <ID клиента в Расчетном центре (РЦ)> | ||
"phoneNumber": "string", | "livingSpace": 0, | ||
"name": "string", | |||
"numberOfRooms": 0, | |||
"personalAccount": "string", | |||
"phoneNumber": "string", | |||
"services": [ | "services": [ | ||
{ | { | ||
"id": <ID | "accrual": 0, | ||
"balance": 0, | |||
"beginningBalance": 0, | |||
"id": 0, <ID услуги в Расчетном центре (РЦ)> | |||
"meters": [ | "meters": [ | ||
{ | { | ||
"id": <ID | "id": 0, <ID счетчика в Расчетном центре (РЦ)> | ||
"indications": [ | "indications": [ | ||
{ | { | ||
"date": | "date": 0, | ||
"id": <ID | "id": 0, <ID переданного показания в Расчетный центр (РЦ)> | ||
" | "meterId": 0, | ||
"value": 0 | |||
} | } | ||
], | ], | ||
"number": "string", | "number": "string", | ||
"seal": "string", | "seal": "string", | ||
"serviceId": | "serviceId": 0, | ||
"type": "string" | "type": "string" | ||
} | } | ||
], | ], | ||
"name": "string", | "name": "string", | ||
"status": | "payment": 0, | ||
"recalculation": 0, | |||
"status": 0 | |||
} | } | ||
], | ], | ||
"substation": "string", | "substation": "string", | ||
"town": "string", | "town": "string", | ||
"transformer": "string" | "transformer": "string" | ||
} | |||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> |
Текущая версия на 17:08, 21 сентября 2022
Общие сведения
API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.
Запрос получения информации о клиенте
Запрос | GET |
URL: https://<URL-адрес сервера>/communal/client/details |
https://<URL-адрес сервера>/communal/client/details |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .
Request Body | KEY/VALUE |
|
"id": <id клиента>,
"organization_id ": <id организации>
|
Response | |
|
{
"apartment": 0,
"address": "string",
"building": "string",
"feeder": "string",
"house": "string",
"id": 0, <ID клиента в Расчетном центре (РЦ)>
"livingSpace": 0,
"name": "string",
"numberOfRooms": 0,
"personalAccount": "string",
"phoneNumber": "string",
"services": [
{
"accrual": 0,
"balance": 0,
"beginningBalance": 0,
"id": 0, <ID услуги в Расчетном центре (РЦ)>
"meters": [
{
"id": 0, <ID счетчика в Расчетном центре (РЦ)>
"indications": [
{
"date": 0,
"id": 0, <ID переданного показания в Расчетный центр (РЦ)>
"meterId": 0,
"value": 0
}
],
"number": "string",
"seal": "string",
"serviceId": 0,
"type": "string"
}
],
"name": "string",
"payment": 0,
"recalculation": 0,
"status": 0
}
],
"substation": "string",
"town": "string",
"transformer": "string"
}
|