Register a new RTSP camera
Creates a new RTSP camera aggregate for a simple plug-and-play camera
curl -X POST "https://api.spkey.co/rtsp-cameras/example_string/RegisterRtspCamera" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"rtspCameraId": "example_string",
"name": "John Doe",
"rtspUrl": "example_string",
"httpSnapshotUrl": "example_string",
"username": "John Doe",
"password": "example_string",
"ownerId": "example_string",
"orgId": "example_string"
}'
import requests
import json
url = "https://api.spkey.co/rtsp-cameras/example_string/RegisterRtspCamera"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"rtspCameraId": "example_string",
"name": "John Doe",
"rtspUrl": "example_string",
"httpSnapshotUrl": "example_string",
"username": "John Doe",
"password": "example_string",
"ownerId": "example_string",
"orgId": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/rtsp-cameras/example_string/RegisterRtspCamera", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"rtspCameraId": "example_string",
"name": "John Doe",
"rtspUrl": "example_string",
"httpSnapshotUrl": "example_string",
"username": "John Doe",
"password": "example_string",
"ownerId": "example_string",
"orgId": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"rtspCameraId": "example_string",
"name": "John Doe",
"rtspUrl": "example_string",
"httpSnapshotUrl": "example_string",
"username": "John Doe",
"password": "example_string",
"ownerId": "example_string",
"orgId": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/rtsp-cameras/example_string/RegisterRtspCamera", 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/rtsp-cameras/example_string/RegisterRtspCamera')
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 = '{
"rtspCameraId": "example_string",
"name": "John Doe",
"rtspUrl": "example_string",
"httpSnapshotUrl": "example_string",
"username": "John Doe",
"password": "example_string",
"ownerId": "example_string",
"orgId": "example_string"
}'
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"
}
]
}
/rtsp-cameras/{id}/RegisterRtspCameraTarget 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.
RTSP Camera UUID
The media type of the request body
Camera UUID (caller-supplied or server-generated)
Human-readable camera name
RTSP stream URL (e.g. rtsp://192.168.1.1:554/stream)
HTTP snapshot URL for still image capture
Camera authentication username
Camera authentication password
User ID who owns this camera (B2C)
Organisation ID that owns this camera (B2B)
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
RTSP Camera UUID
Body
Camera UUID (caller-supplied or server-generated)
Human-readable camera name
RTSP stream URL (e.g. rtsp://192.168.1.1:554/stream)
HTTP snapshot URL for still image capture
Camera authentication username
Camera authentication password
User ID who owns this camera (B2C)
Organisation ID that owns this camera (B2B)
Responses
false