Scopevisio offers a comprehensive REST API for connecting Scopevisio to other automation systems. The first steps for using the REST API are described here.

Creation of a technical user (optional)

To use the REST API, an active user is required in a Scopevisio company. For permanent use in the context of automation, we recommend creating a technical user, e.g. via a functional email address such as scopevisio-automation@example.com. The technical user's e-mail inbox should be created in the Scopevisio customer's IT infrastructure. After creation, the technical user can be added to the Scopevisio company as usual and provided with the required licenses and rights.

Generation of access tokens

An access token is required to use the REST API with a user. This can be created using the command line or Swagger UI.

Create token via command line (curl)

An access token for the REST API can be created using the command line. The following example command with curl is used to create an access token for a user:

^{curl -X 'POST' 'https://appload.scopevisio.com/rest/token' -d 'grant_type=password&customer=<7-digit-cusomer-number>&username=<user-email>&password=<user-password>&organization=<organization-name>'}

The placeholders <7-digit-cusomer-number>, <user-email>, <user-password> and <organization-name> must be replaced with the corresponding values.

In addition to the short-lived access token, the response to the request also contains a long-lived refresh token, which can be used in future to update expired access tokens. This prevents the entry of user names and passwords in applications for automation. Further information can be found in the documentation of the /token endpoint.

Create token using Swagger UI

Alternatively, an access token for the REST API can also be created using our Swagger UI. To do this, the required mandatory fields customer, username, organization and password are filled in for the /token end point and the call is started using "Execute".

Calling the REST API endpoint

The Scopevisio REST API can now be addressed using the access token. A documentation of the endpoints can be found in our Swagger UI.

For example, calling the endpoint /myaccount provides information about the active user.

^{curl -X 'GET' \ -H 'accept: */*' \ -H 'Authorization: Bearer <ACCESS TOKEN>' \ 'https://appload.scopevisio.com/rest/myaccount'}