Provision hub
Registers a manufactured hub in the backend. The IoT Thing must already exist in AWS IoT (created during manufacturing).
curl -X POST "https://api.spkey.co/hubs/example_string/ProvisionHub" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"hubId": "example_string",
"serial": "example_string",
"model": "example_string",
"thingName": "John Doe",
"vendorName": "John Doe"
}'
import requests
import json
url = "https://api.spkey.co/hubs/example_string/ProvisionHub"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"hubId": "example_string",
"serial": "example_string",
"model": "example_string",
"thingName": "John Doe",
"vendorName": "John Doe"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/hubs/example_string/ProvisionHub", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"hubId": "example_string",
"serial": "example_string",
"model": "example_string",
"thingName": "John Doe",
"vendorName": "John Doe"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"hubId": "example_string",
"serial": "example_string",
"model": "example_string",
"thingName": "John Doe",
"vendorName": "John Doe"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/hubs/example_string/ProvisionHub", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/hubs/example_string/ProvisionHub')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"hubId": "example_string",
"serial": "example_string",
"model": "example_string",
"thingName": "John Doe",
"vendorName": "John Doe"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
/hubs/{id}/ProvisionHubTarget server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
Hub ID
The media type of the request body
Hub ID
Hub serial number
Hub model identifier
AWS IoT Thing name (defaults to hubId)
Vendor/manufacturer name
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
Hub ID
Body
Hub ID
Hub serial number
Hub model identifier
AWS IoT Thing name (defaults to hubId)
Vendor/manufacturer name
Responses
falsefalse