Skip to main content
POST
Create manufacturer link session

Authorizations

x-api-key
string
header
required

API key assigned to the manufacturer.

Body

application/json
user_id
string
required

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

Example:

"manufacturer_user_id_123"

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"

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
redirect_url
string<uri>
required

The redirect URL that was provided.

Example:

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

manufacturer
string
required

Name of the manufacturer (resolved from API key).

Example:

"Acme Manufacturing"

manufacturer_user_id
string
required

The manufacturer's user ID.

Example:

"manufacturer_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
string

The manufacturer's brand name (title-cased).

Example:

"Acme Manufacturing"

completed_at
integer | null

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