VISIONAPI

With VISIONAPI, you can easily control VISIONWEB and the evoVIU camera systems VIU1 and VIU2 via an HTTP REST interface. The API provides you with access to all functions that are also available directly on the camera or via the web interface and can be flexibly integrated into your own applications or systems.

The most detailed and up-to-date description of functions can be found in the application's Swagger. All endpoints, parameters, and response formats are clearly documented there. In addition, Swagger allows you to test API functions directly and view the responses in real time.

First Steps VISIONAPI

The easiest way to access Swagger is via the evoVIU application homepage – simply click on “OPEN VISION API”.

You can also open VISIONWEB Swagger directly in your browser via the following link:

http://<DeineIPAdresse>/api/docs/

You will be taken to the Swagger document interface, where all endpoints, parameters, and return values are automatically generated and clearly displayed.

Authentication

To work with Swagger, you must log in to Swagger, similar to logging in to the camera.

As a registered user of VISIONWEB, the first steps are usually performed automatically, provided that no active login is required. First, a token is retrieved, which can then be used to perform all further API calls.

In general, there are two ways to authenticate in Swagger:

1. Registration via permanent user token, see User Management

2. Retrieving a session token and then using this token for API calls.

Regardless of the method chosen, the input is made via the Authorize button at the top right of the Swagger interface. In both cases, a bearer token is used, which is sent with each API call for authentication.

Brief overview Token

The following login details for the master user are stored in the camera by default:

We recommend changing the password for the “Master” user immediately after receiving the camera to protect the system from unauthorized access.

If you have created your own token at User Management, you can also use it for your API calls, independently of the master user.

The advantage: The application will show you when the API is accessing the camera.

Example:

Please note which grants (permissions) you assign to the token when creating it. If it is only the Viewer role, only a few API endpoints are available.

The situation is different for the actual session tokens: these are generated automatically when Swagger or the VISIONWEB platform is accessed. If not used, they remain active for 10 minutes; if used continuously, their validity is extended accordingly.

When using the call:

POST https://<DeineIpAdresse>/api/v1/authentication/sessions/start

The following JSON content is returned. Its value is the token that can be used:

{
  "sessionTokenId": "c991a721-0a56-4e73-822f-215756ed8c2b",
  "activeUntil": "2025-08-09T20:58:15.514Z",
  "created": "2025-08-09T20:48:15.514Z",
  "value": "1d115d39-8078-46ae-ac9e-330e55903670"
}

Sessions Token:

"value": "1d115d39-8078-46ae-ac9e-330e55903670"

Swagger Authorization

If you log in via Authorize, simply enter the token in the input field provided to perform authentication.

Congratulations! You are now logged in via Swagger.

Working Mode “Active State”

Similar to VISIONWEB itself, only one user can make changes to the camera at a time. This also applies to the API when it is to perform certain operations.

General GET functions do not usually require editing rights (editor). So if you only want to retrieve data, you do not necessarily have to be in “edit mode.”

However, the individual functions in Swagger tell you exactly which mode you need to be in and which grants (permissions) are required.

Example 1: The GET function Health is visible to users with Viewer Grant and does not require active edit mode.

Example 2: The PUT function Filesystem/Config is only permitted for users with Editor Grant and higher and can only be executed in active edit mode.

Example 3: The PUT function network/bridging can only be executed by users with administrator grant in active edit mode.

User role in VISIONWEB vs. grant in VISIONAPI

If a function is marked as “active”, it must be called in edit mode; otherwise, this is not necessary.

To enter ActiveState, it must first be requested. This is done after authorization using the following command:

POST https://<DeineIpAdresse>/api/v1/authentication/sessions/current/requestActiveStatus?force=true

Status code 204 confirms that logging in to edit mode was successful.

Congratulations – you can now also execute functions via Swagger that are only available in edit mode. From now on, you can test and try out every single function – as described in Swagger.