Viziosense Integrator Platform API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@viziosense.com License: UNLICENSED

Documentation for Viziosense Integrator

VS Integrator

API Endpoint health

Get health of API

Returns OK if API responding

Responses

Response samples

200

Content type

application/json

"string"

API index

Returns OK if API responding

Responses

Response samples

200

Content type

application/json

"string"

Authentication

API Endpoints for authentication

Logs user into the system

Request Body schema: application/json
required

Created user object

email

required

string (email)

User email

Responses

Request samples

Payload

Content type

application/json

{"email": "jhon.doe@viziosense.ai"
}

Refresh JWT Token

Returns a new JWT token

Request Body schema: application/json
required

refresh_token

string

Responses

Request samples

Payload

Content type

application/json

{"refresh_token": "your-refresh-token"
}

Response samples

200

Content type

application/json

{"token": "string"
}

Send password reset link

Sends a password reset link to the user's email

Request Body schema: application/json
required

email

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@example.com"
}

Response samples

200

Content type

application/json

{"message": "Password reset sent! You'll receive an email if you are registered on our system."
}

Reset password

Resets the user's password

Request Body schema: application/json
required

email	string <email>
token	string
password	string <password>
password_confirmation	string <password>

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@example.com",
"token": "reset-token",
"password": "newpassword",
"password_confirmation": "newpassword"
}

Response samples

200

Content type

application/json

{"message": "Password reset successfully"
}

Groups

API Endpoints for groups

Get detailed group information

Returns detailed group data with devices

path Parameters

uuid

required

string

Group UUID

Responses

Response samples

200

Content type

application/json

{"data": [{"uuid": "68b99dce-dfff-453e-960d-abdde4df56d4",
"name": "string",
"organization": "RMS",
"app_name": "string",
"application_type": "Parking management",
"slug": "string",
"is_archived": true
}
]
}

Devices

API Endpoints for devices

Get list of devices

Returns list of devices

query Parameters

fleet_id	string Filter devices by fleet UUID
localization	string Filter devices by geo localization (city)
is_online	string Enum: "Online" "Offline" Filter devices by online status. Possible values: 'Online', 'Offline'
keyword	string Filter devices by name or keyword
sort	string Enum: "uuid" "name" "status" "refreshed" "version" "fleet.name" "geo_city" "lastSeen" Field to sort by. Allowed values: uuid, name, status, refreshed, version, fleet.name, geo_city, lastSeen
direction	string Enum: "asc" "desc" Sorting direction (asc or desc)
refresh_statuses	boolean If set, refreshes the statuses of devices
is_configured	string Enum: "Configured" "Not configured" Filter by configuration state based on presence of markers.
per_page	integer <int32> Number of items per page

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "1",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "Calipso",
"app_group_id": 0,
"hostname": "device-01",
"total_memory": 8192,
"free_memory": 4096,
"supervisor_version": "1.2.3",
"mac_addresses": ["00:1A:2B:3C:4D:5E",
"00:1A:2B:3C:4D:5F"
],
"os_fullname": "Ubuntu 20.04 LTS",
"os_family": "Linux",
"os_version": "20.04",
"os_kernel": "5.4.0-42-generic",
"geo_timezone": "America/New_York",
"geo_city": "New York",
"geo_country": "USA",
"longitude": -74.006,
"latitude": 40.7128,
"is_online": 1,
"refreshed_at": "2023-08-12T14:15:22Z",
"serial_number": "SN123456789",
"config_meta": {"key": "value"
},
"iot_manager": "AWS",
"iot_id": "iot_123456",
"network": {"interface": "eth0",
"ip": "192.168.1.100"
},
"wifi_config": {"ssid": "MyWiFi",
"password": "securepassword"
},
"notes": "This device is located in the server room.",
"data": {"key1": "value1",
"key2": "value2"
},
"deleted_at": "2023-08-12T14:15:22Z"
}
]
}

Get device information

Returns device data

path Parameters

uuid

required

string

Sensor uuid

Responses

Response samples

200

Content type

application/json

{"id": "1",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "Calipso",
"app_group_id": 0,
"hostname": "device-01",
"total_memory": 8192,
"free_memory": 4096,
"supervisor_version": "1.2.3",
"mac_addresses": ["00:1A:2B:3C:4D:5E",
"00:1A:2B:3C:4D:5F"
],
"os_fullname": "Ubuntu 20.04 LTS",
"os_family": "Linux",
"os_version": "20.04",
"os_kernel": "5.4.0-42-generic",
"geo_timezone": "America/New_York",
"geo_city": "New York",
"geo_country": "USA",
"longitude": -74.006,
"latitude": 40.7128,
"is_online": 1,
"refreshed_at": "2023-08-12T14:15:22Z",
"serial_number": "SN123456789",
"config_meta": {"key": "value"
},
"iot_manager": "AWS",
"iot_id": "iot_123456",
"network": {"interface": "eth0",
"ip": "192.168.1.100"
},
"wifi_config": {"ssid": "MyWiFi",
"password": "securepassword"
},
"notes": "This device is located in the server room.",
"data": {"key1": "value1",
"key2": "value2"
},
"deleted_at": "2023-08-12T14:15:22Z"
}

Update device

Updates device data

path Parameters

uuid

required

string

Sensor uuid

Request Body schema: application/json
required

name required	string <name> (name) Sensor name
uuid	string <uuid> (uuid) Sensor uuid
fleet_id	string (fleet_id) Sensor fleet id
application_id	string (application_id) Sensor Application id
is_ethernet	integer (is_ethernet) Sensor network mode
password_rport	string (password_rport) Sensor Rport password

Responses

Request samples

Payload

Content type

application/json

{"name": "Sensor 1",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"fleet_id": "string",
"application_id": "string",
"is_ethernet": 0,
"password_rport": "string"
}

Response samples

201

Content type

application/json

{"id": "1",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "Calipso",
"app_group_id": 0,
"hostname": "device-01",
"total_memory": 8192,
"free_memory": 4096,
"supervisor_version": "1.2.3",
"mac_addresses": ["00:1A:2B:3C:4D:5E",
"00:1A:2B:3C:4D:5F"
],
"os_fullname": "Ubuntu 20.04 LTS",
"os_family": "Linux",
"os_version": "20.04",
"os_kernel": "5.4.0-42-generic",
"geo_timezone": "America/New_York",
"geo_city": "New York",
"geo_country": "USA",
"longitude": -74.006,
"latitude": 40.7128,
"is_online": 1,
"refreshed_at": "2023-08-12T14:15:22Z",
"serial_number": "SN123456789",
"config_meta": {"key": "value"
},
"iot_manager": "AWS",
"iot_id": "iot_123456",
"network": {"interface": "eth0",
"ip": "192.168.1.100"
},
"wifi_config": {"ssid": "MyWiFi",
"password": "securepassword"
},
"notes": "This device is located in the server room.",
"data": {"key1": "value1",
"key2": "value2"
},
"deleted_at": "2023-08-12T14:15:22Z"
}

Get list of device webhooks

Returns list of webhooks

path Parameters

deviceId

required

integer

Sensor id

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "1",
"url": "https://example.com/webhook",
"type": "string",
"last_7_days": 100,
"error_rate": 5,
"actions": "payload",
"data": {"headers": { },
"params": { }
}
}
]
}

Get a fresh image from the device

Query an image from the device the lastest saved image will be return in case device is offline

path Parameters

uuid

required

string

Sensor uuid

Responses

Get a latest archived image from the device

Query the latest archived image from the device

path Parameters

uuid

required

string

Sensor uuid

Responses

Get a fresh markers config from the device

Query a markers configuration from the device

path Parameters

uuid

required

string

Sensor uuid

Responses

Get device alerts

Returns alerts for a device

path Parameters

uuid

required

string

Sensor uuid

Responses

Get filter information

Returns filter information

Responses

Users

API Endpoints for users

Get list of users

Returns a list of users in the organization

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"email": "string",
"groups": [{"id": 0,
"name": "string"
}
],
"roles": [{"name": "string"
}
],
"status": "string"
}
]

Remove a user

Removes a user from the organization

path Parameters

id

required

integer

User ID

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "User deleted successfully"
}

Invite a new user

Invites a new user to the organization

Request Body schema: application/json
required

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@example.com"
}

Response samples

200

Content type

application/json

{"status": "success",
"message": "Invitation sent to the user"
}

Get current user details

Returns the details of the currently authenticated user

Responses

Markers

API Endpoints for markers

Get list of markers

Returns list of markers with filtering and pagination support

query Parameters

device_uuid	string <uuid> Filter markers by device UUID
group_uuid	string <uuid> Filter markers by group UUID
keyword	string [ 2 .. 255 ] characters Filter markers by name keyword (minimum 2 characters)
sort	string Enum: "name" "device_id" "is_enabled" Field to sort by
is_enabled	string Enum: "1" "0" Filter markers by enabled status
type	string Enum: "spot" "line" "polygon" Filter markers by type
direction	string Enum: "asc" "desc" Sorting direction
per_page	integer <int32> >= 1 Number of items per page (minimum 1)

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 568,
"device_id": 89,
"device_uuid": "407e3b9a-4e1d-4a2f-a032-e904192aabd0",
"device_name": "NCA-COMPTAGE-AVANT",
"device_group_id": 42,
"name": "zone_avant",
"is_enabled": 1,
"uuid": "45d0fc31-ab17-465f-9a5c-272d61cdd87d",
"type": "polygon",
"geometry": {"points": [{"x": 477,
"y": 1076
},
{"x": 1706,
"y": 1071
},
{"x": 1019,
"y": 346
},
{"x": 942,
"y": 356
},
{"x": 818,
"y": 444
}
]
},
"properties": {"color": "rgba(0,255,0,1)"
},
"created_at": "2025-08-27T09:58:02.000000Z"
}
],
"links": {"first": "https://api.viziosense.com/api/v1/markers?page=1",
"last": "https://api.viziosense.com/api/v1/markers?page=9",
"prev": "https://api.viziosense.com/api/v1/markers?page=1",
"next": "https://api.viziosense.com/api/v1/markers?page=2"
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 9,
"links": [{"url": "http://example.com",
"label": "string",
"active": true
}
],
"path": "https://api.viziosense.com/api/v1/markers",
"per_page": 20,
"to": 20,
"total": 178
}
}

Bulk update device markers

Updates multiple markers for a specific device and logs configuration changes to Sentry

Request Body schema: application/json
required

Bulk update markers data

device_uuid required	string <uuid> UUID of the device to update markers for
	Array of objects Array of markers to update

Responses

Request samples

Payload

Content type

application/json

{"device_uuid": "03910230-a84e-4578-8c2f-784cd16cdcc3",
"markers": [{"uuid": "stringstringstringstringstringstring",
"name": "string",
"type": "spot",
"color": "string",
"is_enabled": true,
"geometry": {"center": {"x": 0,
"y": 0
},
"p1": {"x": 0,
"y": 0
},
"p2": {"x": 0,
"y": 0
},
"points": [{"x": 0,
"y": 0
}
]
},
"properties": { }
}
]
}

Response samples

400

Content type

application/json

{"error": "Sensor not found"
}

Invitations

API Endpoints for invitations

Get all pending invitations

Returns all invitations

Responses

Cancel invitation

path Parameters

id	any Invitation ID

Responses

Resend invitation

path Parameters

id	any Invitation ID

Responses

Organizations

API Endpoints for organization

Get webhook secret

Return organization webhook secret

Responses

Rotate webhook secret

Return new organization webhook secret

Responses

Get organization supported classes

Return all supported classes from devices in the organization

Responses

Webhooks

API Endpoints for webhooks

Webhook list for devices

Returns list of webhooks for a specific sensor with the uuid

path Parameters

uuid

required

string

Sensor uuid

Responses

Response samples

200

Content type

application/json

[{"data": [{"id": "1",
"url": "https://example.com/webhook",
"type": "string",
"last_7_days": 100,
"error_rate": 5,
"actions": "payload",
"data": {"headers": { },
"params": { }
}
}
]
}
]

Store new webhook

Create a new webhook for a device

path Parameters

uuid

required

string

Sensor uuid

Request Body schema: application/json
required

url required	string (url) Webhook URL
type	string (type) Webhook request TYPE
actions	string (actions) Webhook trigger actions
headers	string (headers) Webhook headers parameters
params	string (params) Webhook GET or POST parms

Responses

Request samples

Payload

Content type

application/json

{"url": "https://your-company.dev/webhooks",
"type": "POST, GET, PUT, DELETE",
"actions": "pushData",
"headers": "[]",
"params": "[]"
}

Response samples

201

Content type

application/json

{"data": [{"id": "1",
"url": "https://example.com/webhook",
"type": "string",
"last_7_days": 100,
"error_rate": 5,
"actions": "payload",
"data": {"headers": { },
"params": { }
}
}
]
}

Get webhoook information

Returns webhook data

path Parameters

uuid required	string Sensor uuid
id required	integer Webhook id

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "1",
"url": "https://example.com/webhook",
"type": "string",
"last_7_days": 100,
"error_rate": 5,
"actions": "payload",
"data": {"headers": { },
"params": { }
}
}
]
}

Update a webhook

Update data of an existing webhook

path Parameters

uuid required	string Sensor uuid
id required	integer webhook_id

Request Body schema: application/json
required

url required	string (url) Webhook URL
type	string (type) Webhook request TYPE
actions	string (actions) Webhook trigger actions
headers	string (headers) Webhook headers parameters
params	string (params) Webhook GET or POST parms

Responses

Request samples

Payload

Content type

application/json

{"url": "https://your-company.dev/webhooks",
"type": "POST, GET, PUT, DELETE",
"actions": "pushData",
"headers": "[]",
"params": "[]"
}

Response samples

200

Content type

application/json

{"data": [{"id": "1",
"url": "https://example.com/webhook",
"type": "string",
"last_7_days": 100,
"error_rate": 5,
"actions": "payload",
"data": {"headers": { },
"params": { }
}
}
]
}

Delete webhook

Deletes webhook data

path Parameters

id

required

integer

Webhook id

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "1",
"url": "https://example.com/webhook",
"type": "string",
"last_7_days": 100,
"error_rate": 5,
"actions": "payload",
"data": {"headers": { },
"params": { }
}
}
]
}

Battery

Retrieve KPIs and time-series charts for a battery

path Parameters

device_uuid

required

string <uuid>

Unique identifier of the hardware device

query Parameters

range

string

Time range for charts (e.g., 24h, 7d, 30d, 1y). Default 7d

Responses

Response samples

200

Content type

application/json

{"is_paired": true,
"stats": {"protection_events": null,
"cycles": null,
"charts": {"voltage_series": [{"t": "2025-12-22T10:15:30Z",
"v": 52.4
}
],
"current_series": [{"t": "2025-12-22T10:15:30Z",
"v": 52.4
}
],
"capacity_series": [{"t": "2025-12-22T10:15:30Z",
"v": 52.4
}
],
"temp_series": [{"t": "2025-12-22T10:15:30Z",
"v": 52.4
}
]
}
}
}

Check if a battery is paired (lightweight)

path Parameters

device_uuid

required

string <uuid>

Unique identifier of the hardware device

Responses

Response samples

200

Content type

application/json

{"is_paired": true
}

Viziosense Integrator Platform API (1.0.0)

VS Integrator

Get health of API

Responses

Response samples

API index

Responses

Response samples

Authentication

Logs user into the system

Request Body schema: application/jsonrequired

Responses

Request samples

Refresh JWT Token

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Send password reset link

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Reset password

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Groups

Get detailed group information

path Parameters

Responses

Response samples

Devices

Get list of devices

query Parameters

Responses

Response samples

Get device information

path Parameters

Responses

Response samples

Update device

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get list of device webhooks

path Parameters

Responses

Response samples

Get a fresh image from the device

path Parameters

Responses

Get a latest archived image from the device

path Parameters

Responses

Get a fresh markers config from the device

path Parameters

Responses

Get device alerts

path Parameters

Responses

Get filter information

Responses

Users

Get list of users

Responses

Response samples

Remove a user

path Parameters

Responses

Response samples

Invite a new user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get current user details

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required