CASHDESK API:Запрос получения полной информации о клиенте через API: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
Строка 31: | Строка 31: | ||
|}}<br> | |}}<br> | ||
{{ProductTable-2 | |||
|title-left= '''Response''' | |||
|title-right= | |||
|content-left= <br> | |||
* '''building''': | |||
* '''feeder''': | |||
* '''house''': | |||
* '''id''': | |||
* '''name''': | |||
* '''personalAccount''': | |||
* '''phoneNumber''': | |||
* '''id''': | |||
* id: | |||
* date: | |||
* id: | |||
* meterId: | |||
* number: | |||
* seal: | |||
* serviceId: | |||
* type: | |||
* name: | |||
* status: | |||
* substation: | |||
* town: | |||
* transformer: | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | |||
{ | |||
"building": "string", // Корпус | |||
"feeder": "string", // Фидер | |||
"house": "string", // Дом | |||
"id": <ID клиента>, // ID клиента | |||
"name": "string", // ФИО Клиента | |||
"personalAccount": "string", // Лицевой счет | |||
"phoneNumber": "string", // Номер телефона | |||
"services": [ | |||
{ | |||
"id": <ID клиента>, // ID клиента | |||
"meters": [ | |||
{ | |||
"id": <ID клиента>, // ID клиента | |||
"indications": [ | |||
{ | |||
"date": <Время в формате Unix time>, // Время | |||
"id": <ID клиента>, // ID клиента | |||
"meterId": <ID счетчика> // ID счетчика | |||
} | |||
], | |||
"number": "string", // Номер | |||
"seal": "string", // Номер пломбы | |||
"serviceId": <ID клиента>, // ID услуги | |||
"type": "string" // Тип (полное название) | |||
} | |||
], | |||
"name": "string", // Наименование услуги | |||
"status": <Статус подключения клиента> // Статус отключен(0)/подключен(1) | |||
} | |||
], | |||
"substation": "string", // Подстанция | |||
"town": "string", // Населенный пункт | |||
"transformer": "string" // ТП | |||
} | |||
</syntaxhighlight> | |||
|}}<br> | |||
Для получения полной информации о клиенте подготовьте GET запрос следующего вида: | Для получения полной информации о клиенте подготовьте GET запрос следующего вида: |
Версия 16:11, 31 мая 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 <значение acces_token> .
Request Body | KEY/VALUE |
|
"id": <id клиента>,
"organization_id ": <id организации>
|
Response | |
|
{
"building": "string", // Корпус
"feeder": "string", // Фидер
"house": "string", // Дом
"id": <ID клиента>, // ID клиента
"name": "string", // ФИО Клиента
"personalAccount": "string", // Лицевой счет
"phoneNumber": "string", // Номер телефона
"services": [
{
"id": <ID клиента>, // ID клиента
"meters": [
{
"id": <ID клиента>, // ID клиента
"indications": [
{
"date": <Время в формате Unix time>, // Время
"id": <ID клиента>, // ID клиента
"meterId": <ID счетчика> // ID счетчика
}
],
"number": "string", // Номер
"seal": "string", // Номер пломбы
"serviceId": <ID клиента>, // ID услуги
"type": "string" // Тип (полное название)
}
],
"name": "string", // Наименование услуги
"status": <Статус подключения клиента> // Статус отключен(0)/подключен(1)
}
],
"substation": "string", // Подстанция
"town": "string", // Населенный пункт
"transformer": "string" // ТП
}
|
Для получения полной информации о клиенте подготовьте GET запрос следующего вида:
base URL: https://<URL-адрес сервера>/communal/client/details
В AUTHORIZATION укажите значение access_token согласно:
Bearer token : token <значение acces_token>
В PARAMS запроса укажите данные:
"id": <id клиента>,
"organization_id ": <id организации>
Пример ответа на запрос
{
"building": "string", // Корпус
"feeder": "string", // Фидер
"house": "string", // Дом
"id": <ID клиента>, // ID клиента
"name": "string", // ФИО Клиента
"personalAccount": "string", // Лицевой счет
"phoneNumber": "string", // Номер телефона
"services": [
{
"id": <ID клиента>, // ID клиента
"meters": [
{
"id": <ID клиента>, // ID клиента
"indications": [
{
"date": <Время в формате Unix time>, // Время
"id": <ID клиента>, // ID клиента
"meterId": <ID счетчика> // ID счетчика
}
],
"number": "string", // Номер
"seal": "string", // Номер пломбы
"serviceId": <ID клиента>, // ID услуги
"type": "string" // Тип (полное название)
}
],
"name": "string", // Наименование услуги
"status": <Статус подключения клиента> // Статус отключен(0)/подключен(1)
}
],
"substation": "string", // Подстанция
"town": "string", // Населенный пункт
"transformer": "string" // ТП
}