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

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


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


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


В '''AUTHORIZATION''' укажите значение access_token согласно:
{{ProductTable-2
|title-left='''Запрос'''
|title-right='''POST'''
|content-left= <br>URL: https://<URL-адрес сервера>/communal/client/list/read
|content-right=
<syntaxhighlight>
https://<URL-адрес сервера>/communal/client/list/read
</syntaxhighlight>
|}}<br>


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




В '''BODY''' запроса передайте данные в формате JSON согласно структуре.
{{ProductTable-2
|title-left= '''Request body'''
|title-right= '''raw''' (JSON)
|content-left= <br>
* '''apartment''': Квартира
* '''building''': Корпус
* '''house''': Дом
* '''name''': ФИО Клиента
* '''organizationId''': ID организации
* '''personalAccount''': Номер лицевого счета
* '''street''': Улица
* '''town''': Населенный пункт
|content-right=
<syntaxhighlight lang="JSON">
{
  "apartment": "string",
  "building": "string",
  "house": "string",
  "name": "string", 
  "organizationId": <id организации>,
  "personalAccount": "string",
  "street": "string",
  "town": "string"
}
</syntaxhighlight>
|}}<br>


''Пример JSON:''


{{ProductTable-2
|title-left= '''Response'''
|title-right=
|content-left= <br>
* '''id''': ID клиента
* '''name''': ФИО Клиента
* '''personalAccount''': Номер лицевого счета
|content-right=
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
  {
  {
   "apartment": "string",                                    // Квартира
   "id": <id клиента>,
  "building": "string",                                      // Корпус
   "name": "string",
  "house": "string",                                        // Дом
   "personalAccount": "string"
  "name": "string",                                          // ФИО Клиента
  "organizationId": <id организации>,                       // ID организации
   "personalAccount": "string",                               // Номер лицевого счета
   "street": "string",                                        // Улица
  "town": "string"                                           // Населенный пункт
  }
  }
</syntaxhighlight>
</syntaxhighlight>
|}}<br>

Текущая версия на 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"
 }


Источник — http://kassa.bifit.com/wiki/index.php?title=Получение_информации_о_клиентах_(ЖКХ)&oldid=36908