Skip to main content
POST
/
supplier
/
link-sessions
Create supplier link session
curl --request POST \
  --url https://auth.nox.energy/v2/supplier/link-sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "supplier_user_id_123",
  "redirect_url": "https://your-app.com/callback",
  "language": "nl"
}
'
{
  "link_url": "https://auth.nox.energy/ui?token=abc123&language=nl",
  "link_token": "abc123",
  "language": "nl",
  "redirect_url": "https://your-app.com/callback",
  "supplier": "Acme Energy",
  "supplier_user_id": "supplier_user_id_123",
  "created_at": 1703123456,
  "expires_at": 1703124056,
  "completed_at": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.nox.energy/llms.txt

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

Authorizations

​
x-api-key
string
header
required

API key assigned to the supplier.

Body

application/json
​
user_id
string
required

The supplier's internal user ID for the end-user.

Example:

"supplier_user_id_123"

​
asset_type
enum<string>
required

Device category for this link session. Determines which brands are available.

Available options:
hp,
pv
​
redirect_url
string<uri>
required

Callback URL where the user is redirected after completing the flow.

Example:

"https://your-app.com/callback"

​
brand
enum<string> | null

Optionally pre-select a manufacturer brand. Must be a valid brand for the given asset_type.

Available options:
alpha-ess,
alpha-innotec,
apsystems,
atlantic,
bosch,
buderus,
bulex,
ctc,
daikin,
dewarmte,
deye,
enphase,
felicity-solar,
fox-ess,
fronius,
fujitsu,
goodwe,
growatt,
hitachi,
hoymiles,
huawei,
hyxipower,
ilumen,
ivt,
ja-solar,
jaspi,
jinkosolar,
kostal,
lg,
longi,
midea,
mitsubishi,
nibe,
panasonic,
saj,
samsung,
saunier-duval,
sanyo,
sigenergy,
sma,
sofar,
solaredge,
solarman,
solax,
solis,
solarwatt,
sungrow,
sunpower,
talesun,
thermia,
thermor,
toshiba,
trinasolar,
vaillant,
victron,
viessmann
​
language
enum<string>
default:nl

Language for the Authenticator UI.

Available options:
nl,
en,
fr,
es

Response

Link session created successfully.

​
link_url
string<uri>
required

Full URL to redirect the end-user to the NOX Authenticator UI.

Example:

"https://auth.nox.energy/ui?token=abc123&language=nl"

​
link_token
string
required

Unique token identifying this link session.

Example:

"abc123"

​
language
enum<string>
default:nl
required

Language for the Authenticator UI.

Available options:
nl,
en,
fr,
es
​
asset_type
enum<string>
required

Device category: hp (heat pump) or pv (PV solar inverter).

Available options:
hp,
pv
​
redirect_url
string<uri>
required

The redirect URL that was provided.

Example:

"https://your-app.com/callback"

​
supplier
string
required

Name of the supplier (resolved from API key).

Example:

"Acme Energy"

​
supplier_user_id
string
required

The supplier's user ID.

Example:

"supplier_user_id_123"

​
created_at
integer
required

Unix timestamp when the session was created.

Example:

1703123456

​
expires_at
integer
required

Unix timestamp when the session expires (10 minutes after creation).

Example:

1703124056

​
brand
enum<string> | null

Pre-selected brand, if provided.

Available options:
alpha-ess,
alpha-innotec,
apsystems,
atlantic,
bosch,
buderus,
bulex,
ctc,
daikin,
dewarmte,
deye,
enphase,
felicity-solar,
fox-ess,
fronius,
fujitsu,
goodwe,
growatt,
hitachi,
hoymiles,
huawei,
hyxipower,
ilumen,
ivt,
ja-solar,
jaspi,
jinkosolar,
kostal,
lg,
longi,
midea,
mitsubishi,
nibe,
panasonic,
saj,
samsung,
saunier-duval,
sanyo,
sigenergy,
sma,
sofar,
solaredge,
solarman,
solax,
solis,
solarwatt,
sungrow,
sunpower,
talesun,
thermia,
thermor,
toshiba,
trinasolar,
vaillant,
victron,
viessmann
​
completed_at
integer | null

Unix timestamp when the session was completed. Always null on creation.