CASHDESK API:Запрос получения полной информации о клиенте через API

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

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 организации	"id": <id клиента>, "organization_id ": <id организации>

Response

building: Корпус feeder: Фидер house: Дом id: ID клиента name: ФИО Клиента personalAccount: Лицевой счет phoneNumber: Номер телефона id: ID клиента id: ID клиента date: Время в формате Unix Time id: ID клиента meterId: ID счетчика number: Номер счетчика seal: Номер пломбы serviceId: ID услуги type: Тип (полное название) name: Наименование услуги status: Статус отключен(0)/подключен(1) substation: Подстанция town: Населенный пункт transformer: ТП

{ "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"                                   // ТП
 }