/
Heimdall Cloud API

Heimdall Cloud API

Owned by magnus
Last updated: Oct 30, 2023 by Erik LianVersion comment
2 min read

Introduction

The Heimdall Cloud API offers an alternative way to digest power line data and works as a supplement to the Heimdall Cloud App for customers who are looking to process the data further to gain insights into the grid operation. The Heimdall Cloud API is built on the traditional REST architecture and offers the ability to periodically extract, process and analyze the grid data, through simple HTTP requests. Feel free to contact Heimdall if you have any questions or want to enable API access for your organization.

Documentation and testing with Swagger

The Heimdall Cloud API uses Swaggerto provide documentation for the different endpoints the API offers. Head over to the Swagger UI to see descriptions of each endpoint here.

The Swagger UI lets you experiment quickly with endpoint input and output. After you have been granted the API Consumer role, you can click the Authorize button and log in with the same account you use for the Heimdall Cloud App. This allows you to test endpoints with Swagger’s Try it out functionality.

Long-running jobs with a client application

For periodic data consumption a client application is required, which uses the OAuth 2.0 client credentials flow. In this flow a client secret is used to prove the client application’s identity. The flow works like this

  1. The client application obtains an access token

    1. Each access token permits the client to consume the Heimdall API for one hour

  2. The client calls the Heimdall API with the access token and renews the token when expired

The Heimdall API clients repository provides sample implementations in 3 languages. Each client implementation contains a README with instructions to get started.

  • C# / .NET 7

  • Java

  • Python

API demo

Heimdall offers access to demo data if your organization wants to test out the capabilities of the Heimdall Cloud API. After you have been granted access, head out to Swagger demo version of the API here, or run your Heimdall API client of choice with the parameter useDeveloperApi set to false.

Client Secret

The API clients authenticate using the Client Credentials Flow with Azure Active Directory B2C. A client id and secret must be used for authentication, and is provided by Heimdall Power on request.