# Bienport API Documentation ## Docs - [Authentication](https://api-docs.bienport.com/api-reference/authentication.md): Authentication guarantees privacy of API Services by authenticating users. Authentication requires users to log in before accessing Bienport API Services. This guide covers setup for each available handshake method. - [Get Imou Cloud Sub-Account token](https://api-docs.bienport.com/api-reference/camera-api/get-imou-cloud-sub-account-token.md) - [Get Live Stream Info](https://api-docs.bienport.com/api-reference/camera-api/get-live-stream-info.md) - [Get System Info](https://api-docs.bienport.com/api-reference/camera-api/get-system-info.md) - [Add Emergency Contact](https://api-docs.bienport.com/api-reference/central-alarm-monitoring-api/add-emergency-contact.md) - [Generate Alarm Method ](https://api-docs.bienport.com/api-reference/central-alarm-monitoring-api/generate-alarm-method.md) - [Get Emergency Contact](https://api-docs.bienport.com/api-reference/central-alarm-monitoring-api/get-emergency-contact.md) - [Get Contents](https://api-docs.bienport.com/api-reference/content-api/get-contents.md) - [Get Web Content Folders](https://api-docs.bienport.com/api-reference/content-api/get-web-content-folders.md) - [Get All Controllers](https://api-docs.bienport.com/api-reference/controller-api/get-all-controllers.md) - [Get Controller Data Log](https://api-docs.bienport.com/api-reference/controller-log-api/get-controller-data-log.md) - [Get Controller Data Log List](https://api-docs.bienport.com/api-reference/controller-log-api/get-controller-data-log-list.md) - [Add Technical Service Ticket](https://api-docs.bienport.com/api-reference/crm-ticket-api/add-technical-service-ticket.md) - [Adding Ticket Method ](https://api-docs.bienport.com/api-reference/crm-ticket-api/adding-ticket-method.md) - [Get Ticket Method ](https://api-docs.bienport.com/api-reference/crm-ticket-api/get-ticket-method.md) - [List technic service tickets method ](https://api-docs.bienport.com/api-reference/crm-ticket-api/list-technic-service-tickets-method.md) - [Find Customers By Phone Number](https://api-docs.bienport.com/api-reference/customer-api/find-customers-by-phone-number.md) - [Get Customer By Organization Id](https://api-docs.bienport.com/api-reference/customer-api/get-customer-by-organization-id.md) - [Get Organization By Customer Id](https://api-docs.bienport.com/api-reference/customer-api/get-organization-by-customer-id.md) - [Add schedule task](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/add-schedule-task.md) - [Delete schedule task](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/delete-schedule-task.md) - [Filter scheduled tasks](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/filter-scheduled-tasks.md) - [Get Command Queue](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/get-command-queue.md) - [Get Command Queue Resources in operation](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/get-command-queue-resources-in-operation.md) - [Get Organization Users](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/get-organization-users.md) - [Get Panel Users](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/get-panel-users.md) - [Get schedule task](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/get-schedule-task.md) - [Update schedule task](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/update-schedule-task.md) - [User Panel Pairing](https://api-docs.bienport.com/api-reference/enterprise-bulk-operations-api/user-panel-pairing.md) - [Get Last Sensors Data Logs](https://api-docs.bienport.com/api-reference/external-power-and-battery-status-api/get-last-sensors-data-logs.md) - [API Security](https://api-docs.bienport.com/api-reference/introduction.md): This page provides important information about the details you need to know before making API requests. - [Add new lead with mobile.](https://api-docs.bienport.com/api-reference/lead-api/add-new-lead-with-mobile.md) - [Get lead with mobile code](https://api-docs.bienport.com/api-reference/lead-api/get-lead-with-mobile-code.md): customerId, phoneNumber and mobileAppId are optional. But there must be exist at least one of them. - [Authenticate User](https://api-docs.bienport.com/api-reference/login-api/authenticate-user.md) - [Find Controllers By Panel Id](https://api-docs.bienport.com/api-reference/panel-controllers-api/find-controllers-by-panel-id.md) - [Update Controller Description by Panel Controller Id](https://api-docs.bienport.com/api-reference/panel-controllers-api/update-controller-description-by-panel-controller-id.md) - [Find sensors by Panel Id](https://api-docs.bienport.com/api-reference/panel-sensors-api/find-sensors-by-panel-id.md) - [Update Sensor Description by Panel Sensor Id](https://api-docs.bienport.com/api-reference/panel-sensors-api/update-sensor-description-by-panel-sensor-id.md) - [Get Controller Partition Numbers](https://api-docs.bienport.com/api-reference/partition-api/get-controller-partition-numbers.md) - [Get Partition By Resource id And Partition No](https://api-docs.bienport.com/api-reference/partition-api/get-partition-by-resource-id-and-partition-no.md) - [Get Partitions By Resource Id](https://api-docs.bienport.com/api-reference/partition-api/get-partitions-by-resource-id.md) - [Get Sensor Partition Numbers](https://api-docs.bienport.com/api-reference/partition-api/get-sensor-partition-numbers.md) - [Add bank card to wallet](https://api-docs.bienport.com/api-reference/payment-api/add-bank-card-to-wallet.md) - [Add payment via wallet](https://api-docs.bienport.com/api-reference/payment-api/add-payment-via-wallet.md) - [Add payment with bank card information](https://api-docs.bienport.com/api-reference/payment-api/add-payment-with-bank-card-information.md) - [Delete bank card from wallet](https://api-docs.bienport.com/api-reference/payment-api/delete-bank-card-from-wallet.md) - [Getting Bank Card List from Wallet.](https://api-docs.bienport.com/api-reference/payment-api/getting-bank-card-list-from-wallet.md) - [Add or Update Device Token](https://api-docs.bienport.com/api-reference/push-notification-api/add-or-update-device-token.md) - [Get Push Notification History](https://api-docs.bienport.com/api-reference/push-notification-history-api/get-push-notification-history.md) - [Get Event Groups](https://api-docs.bienport.com/api-reference/resource-activities-api/get-event-groups.md) - [Get Resource Activities Between Dates](https://api-docs.bienport.com/api-reference/resource-activities-api/get-resource-activities-between-dates.md) - [Add Camera](https://api-docs.bienport.com/api-reference/resource-api/add-camera.md) - [Get All Cameras By User](https://api-docs.bienport.com/api-reference/resource-api/get-all-cameras-by-user.md) - [Get All Panels By User](https://api-docs.bienport.com/api-reference/resource-api/get-all-panels-by-user.md) - [Get Resource](https://api-docs.bienport.com/api-reference/resource-api/get-resource.md) - [Get Resource](https://api-docs.bienport.com/api-reference/resource-api/get-resource-1.md) - [Refresh Sensors and Controllers](https://api-docs.bienport.com/api-reference/resource-api/refresh-sensors-and-controllers.md): Don't use this often. It takes around 10 seconds and request is blocked until response received from devices - [Update Resource](https://api-docs.bienport.com/api-reference/resource-api/update-resource.md) - [Add Resource Authorization](https://api-docs.bienport.com/api-reference/resource-user-authorization-api/add-resource-authorization.md) - [Delete Resource Authorization](https://api-docs.bienport.com/api-reference/resource-user-authorization-api/delete-resource-authorization.md) - [Add or Update User Privilege Groups And Resources](https://api-docs.bienport.com/api-reference/role-api/add-or-update-user-privilege-groups-and-resources.md) - [Get Organization Roles](https://api-docs.bienport.com/api-reference/role-api/get-organization-roles.md) - [Get Privileges](https://api-docs.bienport.com/api-reference/role-api/get-privileges.md) - [Get Role Privilege Groups By Role Id](https://api-docs.bienport.com/api-reference/role-api/get-role-privilege-groups-by-role-id.md) - [Get User Privilege Groups By User Id ](https://api-docs.bienport.com/api-reference/role-api/get-user-privilege-groups-by-user-id.md) - [Send Verification Code For Account Activation](https://api-docs.bienport.com/api-reference/sms-verification-code-send-api/send-verification-code-for-account-activation.md) - [Send Verification Code For Password Reset](https://api-docs.bienport.com/api-reference/sms-verification-code-send-api/send-verification-code-for-password-reset.md) - [Get all subscription by status and organization id](https://api-docs.bienport.com/api-reference/subscription-api/get-all-subscription-by-status-and-organization-id.md) - [Get Payment Plan Informations](https://api-docs.bienport.com/api-reference/subscription-api/get-payment-plan-informations.md) - [Get Payment Plans](https://api-docs.bienport.com/api-reference/subscription-api/get-payment-plans.md) - [List available camera type of subscriptions](https://api-docs.bienport.com/api-reference/subscription-api/list-available-camera-type-of-subscriptions.md): list of subscriptions where resourceId = null, type = camera* - [Add User](https://api-docs.bienport.com/api-reference/user-api/add-user.md) - [Delete User By Id](https://api-docs.bienport.com/api-reference/user-api/delete-user-by-id.md) - [Find User By Email](https://api-docs.bienport.com/api-reference/user-api/find-user-by-email.md) - [Find User By Id](https://api-docs.bienport.com/api-reference/user-api/find-user-by-id.md) - [Find User By Screen Name](https://api-docs.bienport.com/api-reference/user-api/find-user-by-screen-name.md) - [Get Current User](https://api-docs.bienport.com/api-reference/user-api/get-current-user.md) - [Get User Organizations Users](https://api-docs.bienport.com/api-reference/user-api/get-user-organizations-users.md) - [Reset Password](https://api-docs.bienport.com/api-reference/user-api/reset-password.md) - [Update Password](https://api-docs.bienport.com/api-reference/user-api/update-password.md) - [Update User](https://api-docs.bienport.com/api-reference/user-api/update-user.md) - [User Invite](https://api-docs.bienport.com/api-reference/user-api/user-invite.md) - [User Logout](https://api-docs.bienport.com/api-reference/user-api/user-logout.md) - [Validate Verification Code](https://api-docs.bienport.com/api-reference/validate-verification-code-api/validate-verification-code.md) - [Validate Verification Code For Register](https://api-docs.bienport.com/api-reference/validate-verification-code-api/validate-verification-code-for-register.md) - [Mobile App → Alarm Panel Commands](https://api-docs.bienport.com/mqtt-reference/alarm-panel-commands.md): This section describes how mobile applications can send commands to alarm panels over MQTT, and how responses are delivered back through subscribed topics. - [(Internal) API Gateway ↔ Communication Backend](https://api-docs.bienport.com/mqtt-reference/apigw-backend-commands.md): AMQP-based internal command/response flows between the Api Gateway and Communication Backend service. - [Backend → Mobile App Notifications](https://api-docs.bienport.com/mqtt-reference/backend-mobileapp-notifications.md): AMQP notifications published by Backend for Mobile App clients; consumed via app-specific topics. - [ERP → API Gateway Push Notifications](https://api-docs.bienport.com/mqtt-reference/erp-apigw-push-notifications.md): Domain events pushed from ERP to the Api Gateway via AMQP for customer or subscription information change - [Introduction](https://api-docs.bienport.com/mqtt-reference/mqtt-commands-index.md): This API provides a secure, event-driven way for apps to interact with IoT devices over MQTT and AMQP. 🔐 It enables reliable two-way communication, supporting commands, while also streaming real-time notifications. 📡 In short: developers can both **send structured commands** and **receive live upd… - [Third Party Application → Resource Commands](https://api-docs.bienport.com/mqtt-reference/third-party-commands.md): How external apps control device outputs via MQTT and receive confirmations/notifications. ## OpenAPI Specs - [api-docs](https://api-docs.bienport.com/open-api/api-docs.yml) - [openapi](https://api-docs.bienport.com/api-reference/openapi.json)