Skip to main content
POST
Create partner link session

Authorizations

x-api-key
string
header
required

API key assigned to the partner.

Body

application/json
user_id
string
required

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

Example:

"partner_user_id_123"

asset_type
enum<string>
required

Device category for this link session. Determines which brands are available. This is the type of asset your user connects. It does not need to match your own product category.

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

Callback URL where the user is redirected after completing the flow. Must be a valid http(s) URL. When we redirect back we append a success query param so you can render the right state: on success ?success=true plus a base64-encoded data param (JSON with nox_user_id, supplier_user_id, brand, asset_type, device_ids, connected_at); on failure ?success=false. Any query params you include in the URL yourself are preserved.

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.

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

Example:

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

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"

partner
string
required

Name of the partner (resolved from API key).

Example:

"SolarCo"

partner_user_id
string
required

The partner's user ID.

Example:

"partner_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.