uBox Camera API is made to take your existing uBox cameras and get infromation from them.
There is no official uBox Camera API documentation so this is an unofficial API.
We are NOT affiliated, associated, authorized, endorsed by, or in any way officially connected with UBIA TECHNOLOGIES CO. The official Ubia website can be found at ubianet.com.
| Features | Status |
|---|---|
| List Of Devices | Available |
| Sim Card Info | Available |
| Cloud Recording List | Available |
| Events Calendar | Available |
| Get Cloud Video Url | Available |
| Get Subscribed iOS Devices | Available |
| uBox Camera Stream To RTSP | Upcoming |
| Web Interface | Upcoming |
| Portal.ubianet.com API Documentation | Upcoming |
Choose the correct install for your system
Install Homebrew
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Install NPM and Git
$ brew install npm git
Clone Repo
$ git clone https://github.com/JEMcats/ubox_camera_api.git
Navigate To The Cloned Repo
$ cd ubox_camera_api
Install The Required Dependiences
$ npm install
The API is now setup and ready to be used.
Choose the install for your Linux Distribution
Install NPM And Git
$ sudo apt update
sudo apt install npm git
Clone The Repo
$ git clone https://github.com/JEMcats/ubox_camera_api.git
Navigate To The Cloned Repo
$ cd ubox_camera_api
Install The Required Dependiences
$ npm install
The API is now setup and ready to be used.
If there is another Linux distibution you would like added feel free to open a pull request.
As of now we do not have an install guide for Windows, if you would you would like this added feel free to open a pull request.
Navigate to the directory you have cloned from this repo. If you have not cloned the repository yet please follow the installation directions.
To login to the API create a .env file and write the following
email=your_email
password=your_password
debug_mode=false
server_port=8020
Once you have completed that run the following command
$ node login.js
This will generate a users.json file which will contain your token and other infromation.
If the uBox Camera API ever stops working it is most likely that your login has expired, please run login.js again.
Onece you have run login.js, to use the ubox-camera-api run the following command
$ node server.js
if you get an error this is probably because you have not run login.js try running login.js again.
Once your server has started you will see
Server running on port 8020
in your console.
If you would like to change the port, modify the server_port varible in the env file
The following endpoints can be accessed at localhost:8020, if you change your port the API will be at localhost:YOUR_PORT.
| Endpoint | Method |
|---|---|
| /api/v2/user/device_list | GET |
| /api/user/families | GET |
| /api/user/get_subscription_ios_device | GET |
| /api/v2/user/card4g-info | POST |
| /api/user/cloud_list | POST |
| /api/user/event_calendar | POST |
| /api/user/get_cloud_video_url | POST |
| /api/user/qry/device/device_services | POST |
To hash you password to for using the raw login endpoint portal.ubianet.com/api/v3/login, you will need to hash your password with hash_password.js.
To start make sure that the password=YOUR_PASSWORD value is set in your .env file.
Run this on the command line:
$ node hash_password.js
Wait for the console to say
Hashed Password: HASHEDPASSWORD,
Copy the hashed password and use it as your password in the POST Request JSON Body.
To start make a fork of the dev branch.
In your fork make the changes you would like make.
Fill out the infromation for the pull request.
When you are ready open your pull request.
Here are some troubleshooting steps to take before making a Github issue.
Here is some troubleshooting for login.js
In the uBox app reset your password and try login in with login.js again.