Получение информации о клиентах (ЖКХ)
Версия от 11:02, 13 сентября 2022; Merkulov (обсуждение | вклад)
Общие сведения
API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.
Запрос получения клиентов
Запрос | POST |
URL: https://<URL-адрес сервера>/communal/client/list/read |
https://<URL-адрес сервера>/communal/client/list/read |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .
Request body | raw (JSON) |
|
{
"apartment": "string",
"building": "string",
"house": "string",
"name": "string",
"organizationId": <id организации>,
"personalAccount": "string",
"street": "string",
"town": "string"
}
|
Response | |
|
{
"id": <id клиента>,
"name": "string",
"personalAccount": "string"
}
|