Connect a user you already identify
curl --request POST \
--url https://api.connect.nox.energy/v1/connections \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "<string>",
"identifier": "<string>"
}
'import requests
url = "https://api.connect.nox.energy/v1/connections"
payload = {
"user_id": "<string>",
"identifier": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_id: '<string>', identifier: '<string>'})
};
fetch('https://api.connect.nox.energy/v1/connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.connect.nox.energy/v1/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => '<string>',
'identifier' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.connect.nox.energy/v1/connections"
payload := strings.NewReader("{\n \"user_id\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.connect.nox.energy/v1/connections")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connect.nox.energy/v1/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"<string>\",\n \"identifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"connection_id": "<string>",
"consumer_user_id": "<string>",
"provider": "<string>",
"credential_type": "oauth",
"device_ids": [
"<string>"
],
"needs_reauth": true,
"connected_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "no_devices"
}{
"error": "<string>",
"code": "no_devices"
}{
"error": "<string>",
"code": "no_devices"
}{
"error": "<string>",
"code": "no_devices"
}Connections
Connect a user you already identify
For consumers that are themselves a provider: connects one of your own users without a browser. The provider comes from your API key, so it cannot be named in the body. The identifier is checked by listing the devices it yields; no devices means it is refused.
POST
/
connections
Connect a user you already identify
curl --request POST \
--url https://api.connect.nox.energy/v1/connections \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "<string>",
"identifier": "<string>"
}
'import requests
url = "https://api.connect.nox.energy/v1/connections"
payload = {
"user_id": "<string>",
"identifier": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_id: '<string>', identifier: '<string>'})
};
fetch('https://api.connect.nox.energy/v1/connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.connect.nox.energy/v1/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => '<string>',
'identifier' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.connect.nox.energy/v1/connections"
payload := strings.NewReader("{\n \"user_id\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.connect.nox.energy/v1/connections")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connect.nox.energy/v1/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"<string>\",\n \"identifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"connection_id": "<string>",
"consumer_user_id": "<string>",
"provider": "<string>",
"credential_type": "oauth",
"device_ids": [
"<string>"
],
"needs_reauth": true,
"connected_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "no_devices"
}{
"error": "<string>",
"code": "no_devices"
}{
"error": "<string>",
"code": "no_devices"
}{
"error": "<string>",
"code": "no_devices"
}Authorizations
Your consumer API key.
Body
application/json
Response
Connection created.