Register camera
Registers a camera in 3dEye and persists the registration event.
curl -X POST "https://api.spkey.co/cameras/example_string/RegisterCamera" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"cameraId": "example_string",
"name": "John Doe",
"type": "generic",
"httpUrl": "example_string",
"rtspUrl": "example_string",
"orgId": "example_string",
"ownerId": "example_string",
"login": "example_string",
"password": "example_string",
"port": 42
}'
import requests
import json
url = "https://api.spkey.co/cameras/example_string/RegisterCamera"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"cameraId": "example_string",
"name": "John Doe",
"type": "generic",
"httpUrl": "example_string",
"rtspUrl": "example_string",
"orgId": "example_string",
"ownerId": "example_string",
"login": "example_string",
"password": "example_string",
"port": 42
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/cameras/example_string/RegisterCamera", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"cameraId": "example_string",
"name": "John Doe",
"type": "generic",
"httpUrl": "example_string",
"rtspUrl": "example_string",
"orgId": "example_string",
"ownerId": "example_string",
"login": "example_string",
"password": "example_string",
"port": 42
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"cameraId": "example_string",
"name": "John Doe",
"type": "generic",
"httpUrl": "example_string",
"rtspUrl": "example_string",
"orgId": "example_string",
"ownerId": "example_string",
"login": "example_string",
"password": "example_string",
"port": 42
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/cameras/example_string/RegisterCamera", 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/cameras/example_string/RegisterCamera')
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 = '{
"cameraId": "example_string",
"name": "John Doe",
"type": "generic",
"httpUrl": "example_string",
"rtspUrl": "example_string",
"orgId": "example_string",
"ownerId": "example_string",
"login": "example_string",
"password": "example_string",
"port": 42
}'
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
}
/cameras/{id}/RegisterCameraTarget 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.
Camera ID
The media type of the request body
Camera ID
Camera name
Camera type
HTTP access URL for the camera (http:// or https://)
RTSP streaming URL for the camera (rtsp://)
Organization ID — opaque string, conventionally but not always a UUID
Owner user ID
Camera admin login name (required by 3dEye)
Camera admin password (required by 3dEye)
Optional RTSP port — required for ONVIF cameras (parsed from rtspUrl if omitted).
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
Camera ID
Body
Camera ID
Camera name
HTTP access URL for the camera (http:// or https://)
RTSP streaming URL for the camera (rtsp://)
Organization ID — opaque string, conventionally but not always a UUID
Owner user ID
Camera admin login name (required by 3dEye)
Camera admin password (required by 3dEye)
Optional RTSP port — required for ONVIF cameras (parsed from rtspUrl if omitted).
Responses
falsefalse