Billing Driver API

API для управления услугами домофонии

REST API JSON
⚠️ ВНИМАНИЕ: Эта документация предназначена для разработчиков. Токены доступа являются конфиденциальной информацией и предоставляются отдельно.

Базовый URL

https://pandanus.farm.cpx2.ru/api/v1

Авторизация

Для доступа к API используется Bearer Token авторизация.

Authorization: Bearer <ваш_секретный_токен>

Токен предоставляется администратором системы.

Эндпоинты

GET
/health

Проверка работоспособности API

POST
/blockFlat

Блокировка квартиры. Сохраняет текущие настройки и устанавливает default конфигурацию.

Параметры: partnerName (string), contract (string)

POST
/unblockFlat

Разблокировка квартиры. Восстанавливает сохраненные настройки.

POST
/addService

Добавление услуги к квартире.

Параметры: partnerName (string), contract (string), serviceId (string)

Доступные услуги: domophone, shlagbaum, default

POST
/delService

Удаление услуги с квартиры.

POST
/default

Сброс квартиры к default конфигурации.

Примеры запросов

Блокировка квартиры:

curl -X POST https://pandanus.farm.cpx2.ru/api/v1/blockFlat \\
  -H "Authorization: Bearer <ваш_токен>" \\
  -H "Content-Type: application/json" \\
  -d '{"partnerName":"gorod","contract":"914456"}'

Добавление услуги домофона:

curl -X POST https://pandanus.farm.cpx2.ru/api/v1/addService \\
  -H "Authorization: Bearer <ваш_токен>" \\
  -H "Content-Type: application/json" \\
  -d '{"partnerName":"gorod","contract":"914456","serviceId":"domophone"}'

Добавление услуги шлагбаума:

curl -X POST https://pandanus.farm.cpx2.ru/api/v1/addService \\
  -H "Authorization: Bearer <ваш_токен>" \\
  -H "Content-Type: application/json" \\
  -d '{"partnerName":"gorod","contract":"914456","serviceId":"shlagbaum"}'

Коды ответов