Create an Entity Onboarding Request
curl --request POST \
--url https://api.traxes.io/connect/v1/onboarding/entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand": "<string>",
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pairingCode": "<string>",
"associatedEmail": "<string>",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"identifier": "<string>",
"returnUrl": "<string>",
"track": "<string>"
}
'import requests
url = "https://api.traxes.io/connect/v1/onboarding/entities"
payload = {
"brand": "<string>",
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pairingCode": "<string>",
"associatedEmail": "<string>",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"identifier": "<string>",
"returnUrl": "<string>",
"track": "<string>"
}
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({
brand: '<string>',
collectiveId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pairingCode: '<string>',
associatedEmail: '<string>',
name: '<string>',
owner: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
properties: '<unknown>',
identifier: '<string>',
returnUrl: '<string>',
track: '<string>'
})
};
fetch('https://api.traxes.io/connect/v1/onboarding/entities', 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.traxes.io/connect/v1/onboarding/entities",
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([
'brand' => '<string>',
'collectiveId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pairingCode' => '<string>',
'associatedEmail' => '<string>',
'name' => '<string>',
'owner' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'properties' => '<unknown>',
'identifier' => '<string>',
'returnUrl' => '<string>',
'track' => '<string>'
]),
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.traxes.io/connect/v1/onboarding/entities"
payload := strings.NewReader("{\n \"brand\": \"<string>\",\n \"collectiveId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pairingCode\": \"<string>\",\n \"associatedEmail\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": \"<unknown>\",\n \"identifier\": \"<string>\",\n \"returnUrl\": \"<string>\",\n \"track\": \"<string>\"\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.traxes.io/connect/v1/onboarding/entities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand\": \"<string>\",\n \"collectiveId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pairingCode\": \"<string>\",\n \"associatedEmail\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": \"<unknown>\",\n \"identifier\": \"<string>\",\n \"returnUrl\": \"<string>\",\n \"track\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.traxes.io/connect/v1/onboarding/entities")
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 \"brand\": \"<string>\",\n \"collectiveId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pairingCode\": \"<string>\",\n \"associatedEmail\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": \"<unknown>\",\n \"identifier\": \"<string>\",\n \"returnUrl\": \"<string>\",\n \"track\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"action": {
"documentationLink": "<string>",
"redirectLink": "<string>",
"type": "Consent"
},
"created": "2023-11-07T05:31:56Z",
"data": {
"collective": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"type": "Household"
},
"entity": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"information": {
"type": "Battery",
"brand": "<string>",
"identifier": "<string>",
"pairingCode": "<string>",
"associatedEmail": "<string>",
"name": "<string>",
"track": "<string>"
},
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"reference": {
"brand": "<string>",
"type": "<string>",
"identifier": "<string>"
},
"systemProperties": "<unknown>",
"type": "Battery"
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"description": "<string>",
"message": "<string>"
}
]
}Onboarding API
Create an Entity Onboarding Request
Creates an Entity Onboarding Request and returns the created Entity Onboarding Request.
POST
/
v1
/
onboarding
/
entities
Create an Entity Onboarding Request
curl --request POST \
--url https://api.traxes.io/connect/v1/onboarding/entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand": "<string>",
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pairingCode": "<string>",
"associatedEmail": "<string>",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"identifier": "<string>",
"returnUrl": "<string>",
"track": "<string>"
}
'import requests
url = "https://api.traxes.io/connect/v1/onboarding/entities"
payload = {
"brand": "<string>",
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pairingCode": "<string>",
"associatedEmail": "<string>",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"identifier": "<string>",
"returnUrl": "<string>",
"track": "<string>"
}
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({
brand: '<string>',
collectiveId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pairingCode: '<string>',
associatedEmail: '<string>',
name: '<string>',
owner: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
properties: '<unknown>',
identifier: '<string>',
returnUrl: '<string>',
track: '<string>'
})
};
fetch('https://api.traxes.io/connect/v1/onboarding/entities', 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.traxes.io/connect/v1/onboarding/entities",
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([
'brand' => '<string>',
'collectiveId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pairingCode' => '<string>',
'associatedEmail' => '<string>',
'name' => '<string>',
'owner' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'properties' => '<unknown>',
'identifier' => '<string>',
'returnUrl' => '<string>',
'track' => '<string>'
]),
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.traxes.io/connect/v1/onboarding/entities"
payload := strings.NewReader("{\n \"brand\": \"<string>\",\n \"collectiveId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pairingCode\": \"<string>\",\n \"associatedEmail\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": \"<unknown>\",\n \"identifier\": \"<string>\",\n \"returnUrl\": \"<string>\",\n \"track\": \"<string>\"\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.traxes.io/connect/v1/onboarding/entities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand\": \"<string>\",\n \"collectiveId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pairingCode\": \"<string>\",\n \"associatedEmail\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": \"<unknown>\",\n \"identifier\": \"<string>\",\n \"returnUrl\": \"<string>\",\n \"track\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.traxes.io/connect/v1/onboarding/entities")
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 \"brand\": \"<string>\",\n \"collectiveId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pairingCode\": \"<string>\",\n \"associatedEmail\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": \"<unknown>\",\n \"identifier\": \"<string>\",\n \"returnUrl\": \"<string>\",\n \"track\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"action": {
"documentationLink": "<string>",
"redirectLink": "<string>",
"type": "Consent"
},
"created": "2023-11-07T05:31:56Z",
"data": {
"collective": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"type": "Household"
},
"entity": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"information": {
"type": "Battery",
"brand": "<string>",
"identifier": "<string>",
"pairingCode": "<string>",
"associatedEmail": "<string>",
"name": "<string>",
"track": "<string>"
},
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<unknown>",
"reference": {
"brand": "<string>",
"type": "<string>",
"identifier": "<string>"
},
"systemProperties": "<unknown>",
"type": "Battery"
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"description": "<string>",
"message": "<string>"
}
]
}Important Parameters
enum<string>
required
Specify the type of device or vehicle that you want to connect with.
Available options are
Available options are
Battery, ChargePoint, EV, HeatPump, SolarPlant, RetrofitMeter, Meter, and Inverter.string
required
Specify the manufacturer (for example: “Audi” or “Huawei”) of the device or vehicle you want to connect with.
List all available Entity brands to learn about the available options.
string
A unique identifier asigned by the vehicle or device manufacturer.
Additional Parameters
Some manufacturers may require additional identifiers or special parameters to be set to complete this request. Read our dedicated onboarding guides for more information.Detailed Endpoint Reference
Authorizations
Access Token Authentication
Body
application/jsontext/jsonapplication/*+json
The Entity Onboarding Request.
The entity can be placed in a Collective.
Represents a request to onboard an Entity
The brand of the Entity
Available options:
Battery, ChargePoint, EV, HeatPump, SolarPlant, RetrofitMeter, Meter, Inverter The id of the Collective the Entity will be added to.
The pairing code of the Entity
The associated email address used to onboard the Entity
The name of the Entity
The owner of the Entity
The custom properties of the Entity
The identifier of the Entity
Represents the url where the user will be redirected to after completing the consent flow on the OEM page
The track of the Entity
Response
Created
Represents an onboarding request
Represents an action for an onboarding request
Show child attributes
Show child attributes
The date and time the onboarding request was created.
Represents the data of an onboarding request
Show child attributes
Show child attributes
The id of the onboarding request
The id of the principal that initiated the onboarding request
Available options:
Collective, Entity The url where the User will be redirected to after completing the consent flow on the OEM page.
Available options:
Canceled, Failed, InProgress, Pending, Succeeded Errors that occurred during the processing of the onboarding request
Show child attributes
Show child attributes
Was this page helpful?