Avensor API
The Avensor application programming interface (API) gives the external systems access to Avensor data. The following information is accessible through the APIs:
- Alarms data
- Live data
- Station data
- Device data
- Customer data
- User data
The Avensor APIs are only used to receive the data. The user cannot control the devices or edit data through the Avensor APIs by adding an external client.
Adding an external client
- Log in to Avensor.
- Go to Admin > Customers.
- Select a customer.
- Go to the External clients tab.
- Click the Add button.
- Enter a Name.
- Enter a Description.
It is optional to write a description. - Click Save.
An external client is created and the user gets a unique Auth0 Client ID and a one-time Auth0 Client secret. It is important to save the client secret as it is only displayed once. The client secret is required to access the Avensor REST APIs. If the user forgets the client secret, a new external client must be created.
API documentation
The Avensor API documentation is available in the Avensor application. To access the Avensor API documentation:
- Log in to the Avensor application.
- Click the profile icon in the upper right-hand corner.
- Click the External client resources.
- Click the API link to download the Avensor API YAML file.
The downloaded file contains the following information.
- REST API paths
- Request format
- Response format
- Schema information
To get the more information about the Avensor authentication mechanism and how to call the Avensor APIs, click the Installation Guide link on the External client resources. The downloaded file contains the following information:
- Setting up an external client
- Retrieving the JWT token for Authentication
Related FAQs
Many users have had similar questions about Analytics, Live Data, API and AvensorOPC.