Skip to main content
POST
/
manufacturers
/
suppliers
Connect User to NOX with Supplier OAuth
curl --request POST \
  --url https://auth.nox.energy/manufacturers/suppliers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "manufacturer_user_id": "mfr_user_123",
  "device_ids": [
    "device_001",
    "device_002"
  ],
  "redirect_url": "https://manufacturer-app.com/callback",
  "language": "en"
}
'
{
  "success": true,
  "timestamp": 1703123456,
  "data": {
    "link_token": "abc123def456ghi789",
    "link_url": "https://auth.sandbox.nox.energy/?token=abc123def456&connection_type=manufacturer",
    "expires_at": 1703124056,
    "manufacturer": "Daikin",
    "manufacturer_user_id": "mfr_user_123",
    "nox_user_id": "550e8400-e29b-41d4-a716-446655440000",
    "device_ids": [
      "device_001",
      "device_002"
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can also use 'Authorization: ApiKey YOUR_KEY' header.

Body

application/json
​
manufacturer_user_id
string
required

The manufacturer's unique identifier for the user

Example:

"mfr_user_123"

​
redirect_url
string<uri>
required

URL where the user will be redirected after completing the supplier OAuth flow

Example:

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

​
device_ids
string[]

Optional list of device IDs to associate with this connection

Example:
["device_001", "device_002"]
​
language
string
default:en

Language code for the OAuth redirect page UI (e.g., 'en', 'nl', 'fr')

Example:

"en"

Response

Connection initiated successfully. Redirect user to link_url for OAuth flow.

​
success
boolean
Example:

true

​
timestamp
integer

Unix timestamp

Example:

1703123456

​
data
object