autarc 2.0 API (0.0.1)

This section contains guides that explain how to use the autarc API.

To authenticate with the autarc API, you need to create an API key through the autarc app. You can then use this API key to authenticate with the autarc API by including it in the Authorization header of your HTTP requests. The API key should be prefixed with the word Bearer followed by a space. For example:

Authorization: Bearer API_KEY

Example request:

GET /api/v1/projects HTTP/1.1
Host: api2.autarc.energy
Authorization: Bearer API_KEY

API keys are scoped to the company that created them and can be used to access the resources of that company.

Note: You likely don't need this guide. Please reach out if you think you need OAuth 2.0.

This guide explains how to authenticate against autarc with the OAuth 2.0 protocol. OAuth 2.0 is a protocol that allows a user to grant a third-party application access to their resources without sharing their credentials. This is done by providing the third-party application with an access token that can be used to access the user's resources. The access token is obtained by following a series of steps that involve the user granting permission to the third-party application. The OAuth 2.0 protocol is widely used by many popular services, such as Google, Facebook, and Twitter. In this guide, we will use the OAuth 2.0 protocol to authenticate with autarc.

Step 1: Register your application

Currently we don't support self registration of applications. Please contact us to register your application and get the client ID and client secret.

Step 2: Obtain an access token

To obtain a refresh and access token, you need to follow these steps:

1. Redirect the user to our auth server at: https://auth.autarc.energy/oauth2/auth with the following parameters:
   • response_type=code
   • client_id=YOUR_CLIENT_ID
   • redirect_uri=YOUR_REDIRECT_URI
   • scope=offline_access

The redirect_uri must be a URL that is registered with your application.

2. The user will be prompted to log in and authorize your application. If the user grants permission, they will be redirected back to your redirect_uri with a code parameter in the url. This code can then be exchanged for a refresh and access token in the next step.

3. Exchange the code for a refresh and access token by making a POST request to our token endpoint at: https://auth.autarc.energy/oauth2/token with a Content-Type: application/x-www-form-urlencoded header and the following parameters:

   • grant_type=authorization_code
   • code=CODE_FROM_STEP_2
   • client_id=YOUR_CLIENT_ID
   • client_secret=YOUR_CLIENT_SECRET
   • redirect_uri=YOUR_REDIRECT_URI

The response will contain a refresh and access token that you can use to access the company's resources through the autarc API. The access token will expire after a certain amount of time, but you can use the refresh token to obtain a new access token. Requesting a new access token with the refresh token is done by making a POST request to the same token endpoint (from step 3) with the following parameters:

• grant_type=refresh_token
• refresh_token=REFRESH_TOKEN_FROM_STEP_3
• client_id=YOUR_CLIENT_ID
• client_secret=YOUR_CLIENT_SECRET

Step 3: Use the access token

Once you have obtained an access token, you can use it to access the company's resources through the autarc API. To do this, you need to include the access token in the Authorization header of your HTTP requests. The access token should be prefixed with the word Bearer followed by a space. For example:

Authorization: Bearer ACCESS_TOKEN