Получение информации о клиентах (ЖКХ): различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
 
(нет различий)

Текущая версия на 10:48, 8 ноября 2022

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

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


Запрос получения клиентов

Запрос POST

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


Note.svg Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_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"
 }



Response

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