Create partner link session
Create a new link session to connect a user of a partner, with the intent to authenticate with the asset manufacturer. The returned link_url should be used to redirect the end-user to the NOX Authenticator UI.
Authorizations
API key assigned to the partner.
Body
The partner's internal user ID for the end-user.
"partner_user_id_123"
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.
hp, pv 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.
"https://your-app.com/callback"
Optionally pre-select a manufacturer brand. Must be a valid brand for the given asset_type.
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 for the Authenticator UI.
nl, en, fr, es Response
Link session created successfully.
Full URL to redirect the end-user to the NOX Authenticator UI.
"https://auth.nox.energy/ui?token=abc123&language=nl"
Unique token identifying this link session.
"abc123"
Language for the Authenticator UI.
nl, en, fr, es Device category: hp (heat pump) or pv (PV solar inverter).
hp, pv The redirect URL that was provided.
"https://your-app.com/callback"
Name of the partner (resolved from API key).
"SolarCo"
The partner's user ID.
"partner_user_id_123"
Unix timestamp when the session was created.
1703123456
Unix timestamp when the session expires (10 minutes after creation).
1703124056
Pre-selected brand, if provided.
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 Unix timestamp when the session was completed. Always null on creation.