This section is for integrators or developers that are looking to integrate Rhombus video and device data into their applications.

Common use cases include pulling clips or video streams into access control or monitoring platforms so that users can view corresponding video footage alongside third-party events. To focus this effort, we have compiled some common endpoints and examples to illustrate how to integrate.

Github Examples

Take a look at some of our Rhombus API examples on Github.

• Python, Java, Javascript, CodeGen.

Get a list of users

📘

Use: /api/user/getUsersInOrg

Use this to get a list of all associated users in the organization accessible to the API token.

The returned list includes information such as: the User's UUID, associated notification schedule, etc.

Get a list of all devices

📘

Use: /api/camera/getMinimalCameraStateList

Use this to get a list of all cameras that are accessible to the API token.

The returned list includes information such as: Serial Number, MAC address, State, Camera UUID, IP address, etc.

Getting a list of locations

📘

Use: /api/location/getLocations

Use this to get a list of all locations accessible via the API token.

The returned list includes information such as: Address, Floors, Location UUID, etc.

Creating custom seekpoints on the timeline

📘

Use: /api/camera/createCustomFootageSeekpoint

Use this to create a custom activity seekpoints for a specified camera.

In this example we set the color to purple, and name the custom seekpoint API TEST.

After the request has been sent, the timeline will now show the custom seekpoint. As shown below.