> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Introduction

> Integrate Rhombus cameras, access control, sensors, and alarm monitoring with your systems through the Rhombus REST API, webhooks, and real-time WebSocket events.

## Quick start

1. **Create an API key**

   In the [Rhombus Console](https://console.rhombussystems.com/settings/integrations/api-tokens/), 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](https://developer.rhombus.com/authentication/api-keys) 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):

   ```bash cURL
   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 '{}'
   ```

   ```javascript JavaScript
   const res = await fetch("https://api2.rhombussystems.com/api/camera/getMinimalCameraStateList", {
     method: "POST",
     headers: {
       "x-auth-scheme": "api-token",
       "x-auth-apikey": process.env.RHOMBUS_API_KEY,
       "Content-Type": "application/json",
     },
     body: "{}",
   });
   const { cameraStates } = await res.json();
   console.log(`Found ${cameraStates.length} cameras`);
   ```

   ```python Python
   import os
   import requests

   res = requests.post(
       "https://api2.rhombussystems.com/api/camera/getMinimalCameraStateList",
       headers={
           "x-auth-scheme": "api-token",
           "x-auth-apikey": os.environ["RHOMBUS_API_KEY"],
       },
       json={},
   )
   print(f"Found {len(res.json()['cameraStates'])} cameras")
   ```

   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](https://developer.rhombus.com/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](https://developer.rhombus.com/api-regions).

3. **Pick your next step**

   - **Show video or snapshots in a browser or app:** [Federated tokens](https://developer.rhombus.com/authentication/federated-tokens) and [Streaming video](https://developer.rhombus.com/implementations/streaming-video).
   - **React to alerts, door events and device changes:** [Webhooks](https://developer.rhombus.com/webhooks) or the [WebSocket](https://developer.rhombus.com/websocket/overview).
   - **Find the operation you need:** the [API Reference](https://developer.rhombus.com/api-reference/overview), grouped by product.
   - **Generate a client or connect an AI tool:** [Tools and SDKs](https://developer.rhombus.com/resources).

4. **Go to production**

   Give each integration its own key with the narrowest role that works ([Permissions and key rotation](https://developer.rhombus.com/authentication/permissions)), handle [rate limits](https://developer.rhombus.com/rate-limits), and see the [Trust Center](https://www.rhombus.com/trust/) for security and compliance.

## Support

- **[Rhombus Support](mailto:support@rhombus.com)**: Contact Rhombus Support by email for help with your integration.
- **[Knowledge Base](https://support.rhombussystems.com/hc/en-us)**: Setup and administration articles for Rhombus products.
- **[System Status](https://status.rhombus.com/)**: Current availability and incident history for Rhombus services.
- **[Trust Center](https://www.rhombus.com/trust/)**: Security, data privacy, and compliance information.