Получение информации о клиентах (ЖКХ)

Общие сведения

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 <значение acces_token> .

Request body	raw (JSON)
apartment: Квартира building: Корпус house: Дом name: ФИО Клиента organizationId: ID организации personalAccount: Номер лицевого счета street: Улица town: Населенный пункт	{ "apartment": "string", "building": "string", "house": "string", "name": "string", "organizationId": <id организации>, "personalAccount": "string", "street": "string", "town": "string" }

Подготовьте POST запрос следующего вида:

base URL: https://<URL-адрес сервера>/communal/client/list/read

В AUTHORIZATION укажите значение access_token согласно:

Bearer token : token <значение acces_token>

В BODY запроса передайте данные в формате JSON согласно структуре.

Пример JSON:

 {
  "apartment": "string",                                     // Квартира
  "building": "string",                                      // Корпус
  "house": "string",                                         // Дом
  "name": "string",                                          // ФИО Клиента
  "organizationId": <id организации>,                        // ID организации
  "personalAccount": "string",                               // Номер лицевого счета
  "street": "string",                                        // Улица
  "town": "string"                                           // Населенный пункт
 }

Пример ответа на запрос:

 {
  "id": <id клиента>,                                        // ID клиента
  "name": "string",                                          // ФИО Клиента
  "personalAccount": "string"                                // Номер лицевого счета
 }