Add site auth token

Provide an auth token to Axle, for dispatching the site’s assets.

This token should provide access to all of the assets registered against the specified site.

This is only required where Axle is not able to access this site via an aggregated API in your systems.

POST /entities/site/{site_id}/token

Add Site Auth Token

cURL

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refresh_token": "<string>",
  "access_token": "<string>",
  "token_type": "<string>",
  "expires_utc": "2023-11-07T05:31:56Z",
  "expires_in": 123
}
'

import requests

url = "https://api-sandbox.axle.energy/entities/site/{site_id}/token"

payload = {
    "refresh_token": "<string>",
    "access_token": "<string>",
    "token_type": "<string>",
    "expires_utc": "2023-11-07T05:31:56Z",
    "expires_in": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    refresh_token: '<string>',
    access_token: '<string>',
    token_type: '<string>',
    expires_utc: '2023-11-07T05:31:56Z',
    expires_in: 123
  })
};

fetch('https://api-sandbox.axle.energy/entities/site/{site_id}/token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/entities/site/{site_id}/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'refresh_token' => '<string>',
    'access_token' => '<string>',
    'token_type' => '<string>',
    'expires_utc' => '2023-11-07T05:31:56Z',
    'expires_in' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/entities/site/{site_id}/token"

	payload := strings.NewReader("{\n  \"refresh_token\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"token_type\": \"<string>\",\n  \"expires_utc\": \"2023-11-07T05:31:56Z\",\n  \"expires_in\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.axle.energy/entities/site/{site_id}/token")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"refresh_token\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"token_type\": \"<string>\",\n  \"expires_utc\": \"2023-11-07T05:31:56Z\",\n  \"expires_in\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/entities/site/{site_id}/token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"refresh_token\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"token_type\": \"<string>\",\n  \"expires_utc\": \"2023-11-07T05:31:56Z\",\n  \"expires_in\": 123\n}"

response = http.request(request)
puts response.read_body

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

site_id · string<uuid> · required

Body

application/json

Request model for providing an auth token to enable Axle to access assets at a site.

refresh_token · string

Refresh token for acquiring fresh access tokens after they expire; required, except for 'API_KEY'-type submissions

access_token · string

Access token for dispatching and monitoring assets

token_type · string

Type of token (e.g. 'Bearer' or 'API_KEY')

expires_utc · string<date-time>

Time in UTC at which the token expires

expires_in · integer

Time in seconds until the token expires

Response

200

application/json

Token successfully processed