generate onboarding url
curl --request POST \
--url https://api.example.com/v1/onboarding/url/generate \
--header 'Content-Type: application/json' \
--header 'x-ws-api-key: <api-key>' \
--data '
{
"userId": "user_123456789",
"userEmail": "[email protected]",
"redirectUrl": "https://example.com/onboarding/complete",
"enableThirdPartyDevice": true,
"hvacs": [
{
"name": "Living room thermostat",
"enabled": true,
"defaultMode": "AUTO",
"tempUnits": "F",
"maxTemp": 78,
"minTemp": 60,
"defaultCoolSetpoint": 74,
"defaultHeatSetpoint": 68,
"deviceType": "Hvac",
"canHeat": true,
"canCool": true,
"targetTemp": true,
"targetCoolSetpoint": 74,
"targetHeatSetpoint": 68,
"currentTemp": 71,
"referenceId": "thermostat-1"
}
]
}
'import requests
url = "https://api.example.com/v1/onboarding/url/generate"
payload = {
"userId": "user_123456789",
"userEmail": "[email protected]",
"redirectUrl": "https://example.com/onboarding/complete",
"enableThirdPartyDevice": True,
"hvacs": [
{
"name": "Living room thermostat",
"enabled": True,
"defaultMode": "AUTO",
"tempUnits": "F",
"maxTemp": 78,
"minTemp": 60,
"defaultCoolSetpoint": 74,
"defaultHeatSetpoint": 68,
"deviceType": "Hvac",
"canHeat": True,
"canCool": True,
"targetTemp": True,
"targetCoolSetpoint": 74,
"targetHeatSetpoint": 68,
"currentTemp": 71,
"referenceId": "thermostat-1"
}
]
}
headers = {
"x-ws-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-ws-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: 'user_123456789',
userEmail: '[email protected]',
redirectUrl: 'https://example.com/onboarding/complete',
enableThirdPartyDevice: true,
hvacs: [
{
name: 'Living room thermostat',
enabled: true,
defaultMode: 'AUTO',
tempUnits: 'F',
maxTemp: 78,
minTemp: 60,
defaultCoolSetpoint: 74,
defaultHeatSetpoint: 68,
deviceType: 'Hvac',
canHeat: true,
canCool: true,
targetTemp: true,
targetCoolSetpoint: 74,
targetHeatSetpoint: 68,
currentTemp: 71,
referenceId: 'thermostat-1'
}
]
})
};
fetch('https://api.example.com/v1/onboarding/url/generate', 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.example.com/v1/onboarding/url/generate",
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([
'userId' => 'user_123456789',
'userEmail' => '[email protected]',
'redirectUrl' => 'https://example.com/onboarding/complete',
'enableThirdPartyDevice' => true,
'hvacs' => [
[
'name' => 'Living room thermostat',
'enabled' => true,
'defaultMode' => 'AUTO',
'tempUnits' => 'F',
'maxTemp' => 78,
'minTemp' => 60,
'defaultCoolSetpoint' => 74,
'defaultHeatSetpoint' => 68,
'deviceType' => 'Hvac',
'canHeat' => true,
'canCool' => true,
'targetTemp' => true,
'targetCoolSetpoint' => 74,
'targetHeatSetpoint' => 68,
'currentTemp' => 71,
'referenceId' => 'thermostat-1'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ws-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.example.com/v1/onboarding/url/generate"
payload := strings.NewReader("{\n \"userId\": \"user_123456789\",\n \"userEmail\": \"[email protected]\",\n \"redirectUrl\": \"https://example.com/onboarding/complete\",\n \"enableThirdPartyDevice\": true,\n \"hvacs\": [\n {\n \"name\": \"Living room thermostat\",\n \"enabled\": true,\n \"defaultMode\": \"AUTO\",\n \"tempUnits\": \"F\",\n \"maxTemp\": 78,\n \"minTemp\": 60,\n \"defaultCoolSetpoint\": 74,\n \"defaultHeatSetpoint\": 68,\n \"deviceType\": \"Hvac\",\n \"canHeat\": true,\n \"canCool\": true,\n \"targetTemp\": true,\n \"targetCoolSetpoint\": 74,\n \"targetHeatSetpoint\": 68,\n \"currentTemp\": 71,\n \"referenceId\": \"thermostat-1\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ws-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.example.com/v1/onboarding/url/generate")
.header("x-ws-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"user_123456789\",\n \"userEmail\": \"[email protected]\",\n \"redirectUrl\": \"https://example.com/onboarding/complete\",\n \"enableThirdPartyDevice\": true,\n \"hvacs\": [\n {\n \"name\": \"Living room thermostat\",\n \"enabled\": true,\n \"defaultMode\": \"AUTO\",\n \"tempUnits\": \"F\",\n \"maxTemp\": 78,\n \"minTemp\": 60,\n \"defaultCoolSetpoint\": 74,\n \"defaultHeatSetpoint\": 68,\n \"deviceType\": \"Hvac\",\n \"canHeat\": true,\n \"canCool\": true,\n \"targetTemp\": true,\n \"targetCoolSetpoint\": 74,\n \"targetHeatSetpoint\": 68,\n \"currentTemp\": 71,\n \"referenceId\": \"thermostat-1\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/onboarding/url/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ws-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"user_123456789\",\n \"userEmail\": \"[email protected]\",\n \"redirectUrl\": \"https://example.com/onboarding/complete\",\n \"enableThirdPartyDevice\": true,\n \"hvacs\": [\n {\n \"name\": \"Living room thermostat\",\n \"enabled\": true,\n \"defaultMode\": \"AUTO\",\n \"tempUnits\": \"F\",\n \"maxTemp\": 78,\n \"minTemp\": 60,\n \"defaultCoolSetpoint\": 74,\n \"defaultHeatSetpoint\": 68,\n \"deviceType\": \"Hvac\",\n \"canHeat\": true,\n \"canCool\": true,\n \"targetTemp\": true,\n \"targetCoolSetpoint\": 74,\n \"targetHeatSetpoint\": 68,\n \"currentTemp\": 71,\n \"referenceId\": \"thermostat-1\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"url": "https://onboarding.wattshift.com/session/abc123",
"homeId": "ws_home_123456789"
}onboarding
generate onboarding url
POST
/
v1
/
onboarding
/
url
/
generate
generate onboarding url
curl --request POST \
--url https://api.example.com/v1/onboarding/url/generate \
--header 'Content-Type: application/json' \
--header 'x-ws-api-key: <api-key>' \
--data '
{
"userId": "user_123456789",
"userEmail": "[email protected]",
"redirectUrl": "https://example.com/onboarding/complete",
"enableThirdPartyDevice": true,
"hvacs": [
{
"name": "Living room thermostat",
"enabled": true,
"defaultMode": "AUTO",
"tempUnits": "F",
"maxTemp": 78,
"minTemp": 60,
"defaultCoolSetpoint": 74,
"defaultHeatSetpoint": 68,
"deviceType": "Hvac",
"canHeat": true,
"canCool": true,
"targetTemp": true,
"targetCoolSetpoint": 74,
"targetHeatSetpoint": 68,
"currentTemp": 71,
"referenceId": "thermostat-1"
}
]
}
'import requests
url = "https://api.example.com/v1/onboarding/url/generate"
payload = {
"userId": "user_123456789",
"userEmail": "[email protected]",
"redirectUrl": "https://example.com/onboarding/complete",
"enableThirdPartyDevice": True,
"hvacs": [
{
"name": "Living room thermostat",
"enabled": True,
"defaultMode": "AUTO",
"tempUnits": "F",
"maxTemp": 78,
"minTemp": 60,
"defaultCoolSetpoint": 74,
"defaultHeatSetpoint": 68,
"deviceType": "Hvac",
"canHeat": True,
"canCool": True,
"targetTemp": True,
"targetCoolSetpoint": 74,
"targetHeatSetpoint": 68,
"currentTemp": 71,
"referenceId": "thermostat-1"
}
]
}
headers = {
"x-ws-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-ws-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: 'user_123456789',
userEmail: '[email protected]',
redirectUrl: 'https://example.com/onboarding/complete',
enableThirdPartyDevice: true,
hvacs: [
{
name: 'Living room thermostat',
enabled: true,
defaultMode: 'AUTO',
tempUnits: 'F',
maxTemp: 78,
minTemp: 60,
defaultCoolSetpoint: 74,
defaultHeatSetpoint: 68,
deviceType: 'Hvac',
canHeat: true,
canCool: true,
targetTemp: true,
targetCoolSetpoint: 74,
targetHeatSetpoint: 68,
currentTemp: 71,
referenceId: 'thermostat-1'
}
]
})
};
fetch('https://api.example.com/v1/onboarding/url/generate', 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.example.com/v1/onboarding/url/generate",
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([
'userId' => 'user_123456789',
'userEmail' => '[email protected]',
'redirectUrl' => 'https://example.com/onboarding/complete',
'enableThirdPartyDevice' => true,
'hvacs' => [
[
'name' => 'Living room thermostat',
'enabled' => true,
'defaultMode' => 'AUTO',
'tempUnits' => 'F',
'maxTemp' => 78,
'minTemp' => 60,
'defaultCoolSetpoint' => 74,
'defaultHeatSetpoint' => 68,
'deviceType' => 'Hvac',
'canHeat' => true,
'canCool' => true,
'targetTemp' => true,
'targetCoolSetpoint' => 74,
'targetHeatSetpoint' => 68,
'currentTemp' => 71,
'referenceId' => 'thermostat-1'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ws-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.example.com/v1/onboarding/url/generate"
payload := strings.NewReader("{\n \"userId\": \"user_123456789\",\n \"userEmail\": \"[email protected]\",\n \"redirectUrl\": \"https://example.com/onboarding/complete\",\n \"enableThirdPartyDevice\": true,\n \"hvacs\": [\n {\n \"name\": \"Living room thermostat\",\n \"enabled\": true,\n \"defaultMode\": \"AUTO\",\n \"tempUnits\": \"F\",\n \"maxTemp\": 78,\n \"minTemp\": 60,\n \"defaultCoolSetpoint\": 74,\n \"defaultHeatSetpoint\": 68,\n \"deviceType\": \"Hvac\",\n \"canHeat\": true,\n \"canCool\": true,\n \"targetTemp\": true,\n \"targetCoolSetpoint\": 74,\n \"targetHeatSetpoint\": 68,\n \"currentTemp\": 71,\n \"referenceId\": \"thermostat-1\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ws-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.example.com/v1/onboarding/url/generate")
.header("x-ws-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"user_123456789\",\n \"userEmail\": \"[email protected]\",\n \"redirectUrl\": \"https://example.com/onboarding/complete\",\n \"enableThirdPartyDevice\": true,\n \"hvacs\": [\n {\n \"name\": \"Living room thermostat\",\n \"enabled\": true,\n \"defaultMode\": \"AUTO\",\n \"tempUnits\": \"F\",\n \"maxTemp\": 78,\n \"minTemp\": 60,\n \"defaultCoolSetpoint\": 74,\n \"defaultHeatSetpoint\": 68,\n \"deviceType\": \"Hvac\",\n \"canHeat\": true,\n \"canCool\": true,\n \"targetTemp\": true,\n \"targetCoolSetpoint\": 74,\n \"targetHeatSetpoint\": 68,\n \"currentTemp\": 71,\n \"referenceId\": \"thermostat-1\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/onboarding/url/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ws-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"user_123456789\",\n \"userEmail\": \"[email protected]\",\n \"redirectUrl\": \"https://example.com/onboarding/complete\",\n \"enableThirdPartyDevice\": true,\n \"hvacs\": [\n {\n \"name\": \"Living room thermostat\",\n \"enabled\": true,\n \"defaultMode\": \"AUTO\",\n \"tempUnits\": \"F\",\n \"maxTemp\": 78,\n \"minTemp\": 60,\n \"defaultCoolSetpoint\": 74,\n \"defaultHeatSetpoint\": 68,\n \"deviceType\": \"Hvac\",\n \"canHeat\": true,\n \"canCool\": true,\n \"targetTemp\": true,\n \"targetCoolSetpoint\": 74,\n \"targetHeatSetpoint\": 68,\n \"currentTemp\": 71,\n \"referenceId\": \"thermostat-1\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"url": "https://onboarding.wattshift.com/session/abc123",
"homeId": "ws_home_123456789"
}Authorizations
WattShift API key
Headers
WattShift API Key
Body
application/json
⌘I
