CASHDESK API:Запрос получения полной информации о клиенте через API: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
Строка 1: | Строка 1: | ||
== Общие сведения == | |||
'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы к сервису '''БИФИТ Бизнес''' осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи. | |||
== Запрос получения информации о клиенте == | |||
{{ProductTable-2 | |||
|title-left='''Запрос''' | |||
|title-right='''GET''' | |||
|content-left= <br>URL: https://<URL-адрес сервера>/communal/client/details | |||
|content-right= | |||
<syntaxhighlight> | |||
https://<URL-адрес сервера>/communal/client/details | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{Note|'''''Важно!'''''<br> | |||
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''acces_token'''> .|800}} | |||
{{ProductTable-2 | |||
|title-left= '''Request Body''' | |||
|title-right= | |||
|content-left= <br> ID созданной номенклатуры | |||
|content-right= | |||
<syntaxhighlight> | |||
23923080 | |||
</syntaxhighlight> | |||
|}}<br> | |||
Для получения полной информации о клиенте подготовьте GET запрос следующего вида: | Для получения полной информации о клиенте подготовьте GET запрос следующего вида: | ||
Версия 15:52, 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 | |
ID созданной номенклатуры |
23923080 |
Для получения полной информации о клиенте подготовьте 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" // ТП
}