CASHDESK API:Запрос получения полной информации о клиенте через API: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
Строка 36: | Строка 36: | ||
|title-right= | |title-right= | ||
|content-left= <br> | |content-left= <br> | ||
* '''building''': | * '''building''': Корпус | ||
* '''feeder''': | * '''feeder''': Фидер | ||
* '''house''': | * '''house''': Дом | ||
* '''id''': | * '''id''': ID клиента | ||
* '''name''': | * '''name''': ФИО Клиента | ||
* '''personalAccount''': | * '''personalAccount''': Лицевой счет | ||
* '''phoneNumber''': | * '''phoneNumber''': Номер телефона | ||
* '''id''': | * '''id''': ID клиента | ||
* id: | * '''id''': ID клиента | ||
* date: | * '''date''': Время в формате Unix Time | ||
* id: | * '''id''': ID клиента | ||
* meterId: | * '''meterId''': ID счетчика | ||
* number: | * '''number''': Номер счетчика | ||
* seal: | * '''seal''': Номер пломбы | ||
* serviceId: | * '''serviceId''': ID услуги | ||
* type: | * '''type''': Тип (полное название) | ||
* name: | * '''name''': Наименование услуги | ||
* status: | * '''status''': Статус отключен(0)/подключен(1) | ||
* substation: | * '''substation''': Подстанция | ||
* town: | * '''town''': Населенный пункт | ||
* transformer: | * '''transformer''': ТП | ||
|content-right= | |content-right= | ||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"building": "string", | "building": "string", | ||
"feeder": "string", | "feeder": "string", | ||
"house": "string", | "house": "string", | ||
"id": <ID клиента>, | "id": <ID клиента>, | ||
"name": "string", | "name": "string", | ||
"personalAccount": "string", | "personalAccount": "string", | ||
"phoneNumber": "string", | "phoneNumber": "string", | ||
"services": [ | "services": [ | ||
{ | { | ||
"id": <ID клиента>, | "id": <ID клиента>, | ||
"meters": [ | "meters": [ | ||
{ | { | ||
"id": <ID клиента>, | "id": <ID клиента>, | ||
"indications": [ | "indications": [ | ||
{ | { | ||
"date": <Время в формате Unix time>, | "date": <Время в формате Unix time>, | ||
"id": <ID клиента>, | "id": <ID клиента>, | ||
"meterId": <ID счетчика> | "meterId": <ID счетчика> | ||
} | } | ||
], | ], | ||
"number": "string", | "number": "string", | ||
"seal": "string", | "seal": "string", | ||
"serviceId": <ID клиента>, | "serviceId": <ID клиента>, | ||
"type": "string" | "type": "string" | ||
} | } | ||
], | ], | ||
"name": "string", | "name": "string", | ||
"status": <Статус подключения клиента> | "status": <Статус подключения клиента> | ||
} | } | ||
], | ], | ||
"substation": "string", | "substation": "string", | ||
"town": "string", | "town": "string", | ||
"transformer": "string" | "transformer": "string" | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> |
Версия 16:22, 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 клиента>,
"name": "string",
"personalAccount": "string",
"phoneNumber": "string",
"services": [
{
"id": <ID клиента>,
"meters": [
{
"id": <ID клиента>,
"indications": [
{
"date": <Время в формате Unix time>,
"id": <ID клиента>,
"meterId": <ID счетчика>
}
],
"number": "string",
"seal": "string",
"serviceId": <ID клиента>,
"type": "string"
}
],
"name": "string",
"status": <Статус подключения клиента>
}
],
"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" // ТП
}