CommandRegister camera

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
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/cameras/{id}/RegisterCamera
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Camera name

Min length: 1
typestring
Required

Camera type

Options: generic, onvif, pnp
httpUrlstring
Required

HTTP access URL for the camera (http:// or https://)

Format: uri
rtspUrlstring
Required

RTSP streaming URL for the camera (rtsp://)

Format: uri
orgIdstring
Required

Organization ID — opaque string, conventionally but not always a UUID

Min length: 1
loginstring
Required

Camera admin login name (required by 3dEye)

Min length: 1
passwordstring
Required

Camera admin password (required by 3dEye)

Min length: 1
portinteger

Optional RTSP port — required for ONVIF cameras (parsed from rtspUrl if omitted).

Max: 65535
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Body

application/json
typestring
Required

Camera type

Allowed values:genericonvifpnp
httpUrlstring
Required

HTTP access URL for the camera (http:// or https://)

rtspUrlstring
Required

RTSP streaming URL for the camera (rtsp://)

orgIdstring
Required

Organization ID — opaque string, conventionally but not always a UUID

loginstring
Required

Camera admin login name (required by 3dEye)

passwordstring
Required

Camera admin password (required by 3dEye)

portinteger

Optional RTSP port — required for ONVIF cameras (parsed from rtspUrl if omitted).

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required