Skip to main content
POST
/
api
/
partners
/
v2.0
/
device-onboarding
Create a new Device Onboarding Session
curl --request POST \
  --url https://api.example.com/api/partners/v2.0/device-onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "success_url": "<string>",
  "cancel_url": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "language": "en",
  "price_zone_default": "AT",
  "is_smart_optimization_active_default": true,
  "skip_to": "ev",
  "external_metadata": {}
}
'
{
  "authentication_url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "price_zone_default": "AT",
  "is_smart_optimization_active_default": true,
  "skip_to": "ev",
  "expiration_date": "2023-12-25",
  "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_metadata": {},
  "language": "en"
}

Documentation Index

Fetch the complete documentation index at: https://developers.podero.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Body

application/json
success_url
string
required
Maximum string length: 8000
cancel_url
string
required
Maximum string length: 8000
user_id
string<uuid>
required
language
enum<string>
default:en
Available options:
sv,
de,
en,
hu,
it,
et,
pl,
ro
price_zone_default
enum<string> | null
Available options:
AT,
AT_HOURLY,
BE,
CH,
EE,
DE_LU,
HU,
IT_CNOR,
IT_CSUD,
IT_NORD,
IT_PUN,
IT_SARD,
IT_SICI,
IT_SUD,
PT,
RO,
SE_1,
SE_2,
SE_3,
SE_4,
UK
is_smart_optimization_active_default
boolean | null
skip_to
enum<string> | null
Available options:
ev,
iv,
wb,
hp
external_metadata
External Metadata · object

Response

200 - application/json

OK

authentication_url
string
required
id
string<uuid>
required
user
string<uuid>
required
success_url
string
required
Maximum string length: 8000
cancel_url
string
required
Maximum string length: 8000
price_zone_default
enum<string> | null
Available options:
AT,
AT_HOURLY,
BE,
CH,
EE,
DE_LU,
HU,
IT_CNOR,
IT_CSUD,
IT_NORD,
IT_PUN,
IT_SARD,
IT_SICI,
IT_SUD,
PT,
RO,
SE_1,
SE_2,
SE_3,
SE_4,
UK
is_smart_optimization_active_default
boolean | null
skip_to
enum<string> | null
Available options:
ev,
iv,
wb,
hp
expiration_date
string<date>
object_id
string<uuid> | null
external_metadata
External Metadata · object
language
string
default:en
Maximum string length: 255