The 3dEYE API allows you to integrate your own software or any third‑party application with the 3dEYE platform. With more than 75 available API methods, you can automate routine tasks and programmatically create, modify, or delete various components of the system.
API methods support operations such as:
Creating and managing customers
Adding and configuring cameras
Managing users and roles
Retrieving Events data
Automating workflows
For the API methods to work you will need to obtain a correct API key for the correct customer level. Each integrator and customer has a unique API key and their values can be found from the API Keys menu or using your integrator API key and Get API Key method from our collection.
For example, when creating a new customer an integrator API key has to be used but when creating and assigning a new camera to an existing customer a customer API key has to be entered.
To access documentation and view your integrator API key open the profile menu and select API menu from there.
Enable / Disable API Access
Use the Enable/Disable slider to turn API access on or off for a specific customer.
Enabled → Customer can use API methods
Disabled → All API access for that customer is blocked
This is helpful for security, temporary suspensions, or preventing unauthorized integrations.
To view documentation and examples on how to use API methods open the API menu from your profile dropdown menu and click on the API Documents link: