Show live video, unlock doors and react to events from your app.

Quick start

1. Create an API key

   In the Rhombus Console, go to Settings → Integrations & Developer Resources → API Tokens and click Add API Key. Give it a Name, leave Auth Type on Api Token, and choose a Role: the key can do whatever the role allows, so start with a read-only one. The key is shown only once, so copy it now. API keys and certificates covers certificate (mTLS) keys and the other credentials.

2. Make your first request

   List the cameras in your organization. The key goes in two headers, and almost every operation is a POST with a JSON body ({} when it takes no parameters):

   cURLJavaScriptPython

   bash

   curl -X POST "https://api2.rhombussystems.com/api/camera/getMinimalCameraStateList" \
     -H "x-auth-scheme: api-token" \
     -H "x-auth-apikey: $RHOMBUS_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{}'

   The response lists one entry per camera:

   json

   {
     "error": false,
     "cameraStates": [
       {
         "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
         "name": "Front Lobby",
         "locationUuid": "BBBBBBBBBBBBBBBBBBBBBB",
         "connectionStatus": "GREEN",
         "healthStatus": "GREEN"
       }
     ]
   }

   Check error as well as the HTTP status: some failures return 200 with "error": true and an errorMsg (Errors). Organizations in the EU (console at console.eu.rhombussystems.com) use https://api2.eu.rhombussystems.com, and keys work only in their own region; see API regions.

3. Pick your next step
   • Show video or snapshots in a browser or app: Federated tokens and Streaming video.
   • React to alerts, door events and device changes: Webhooks or the WebSocket.
   • Find the operation you need: the API Reference, grouped by product.
   • Generate a client or connect an AI tool: Tools and SDKs.
4. Go to production

   Give each integration its own key with the narrowest role that works (Permissions and key rotation), handle rate limits, and see the Trust Center for security and compliance.

Support