Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Invendor Devices API

The Devices API from Invendor — 10 operation(s) for devices.

Invendor Devices API is one of 42 APIs that Invendor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 12 operations across 10 paths, and defines 27 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against the base URL https://api.invendor.com.

12 operations 10 paths 27 schemas 1 DELETE6 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.invendor.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Invendor Devices API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Devices 12
GET
/v1/Devices/commands
Returns list of available device commands
Device commands 1 param → 200400401403
GET
/v1/Devices
Returns list of devices for the tenant
Devices list 7 params → 200400401403
GET
/v1/Devices/{deviceId}
Returns device details
Device details 2 params → 200400401403
PUT
/v1/Devices/{deviceId}
Update tenant device information
Update tenant device information 2 params body → 200400401403
DELETE
/v1/Devices/{deviceId}
Delete tenant device
Delete tenant device 2 params → 200400401403
POST
/v1/Devices/{deviceId}/command
Send FireBase command to the device
Send command to the device 2 params body → 204400401403
POST
/v1/Devices/locations/{locationId}/sync_users
Notifies all devices in the location to sync users
Sync location users in related devices 2 params → 204400422401403
GET
/v1/Devices/{deviceId}/heartbeats
Returns list of device heartbeats
Device heartbeats list 7 params → 200400401403
GET
/v1/Devices/{deviceId}/events
Returns list of device events
Device events list 7 params → 200400401403
POST
/v1/Devices/dedicated/register/pre
Pre register tenant dedicated device
1 param body → 201400401403
POST
/v1/Devices/{deviceId}/regen
Authorise dedicated device to aquire new secret
2 params → 200400401403
GET
/v1/Devices/free-cabinets
Returns list of free cabinets for the tenant, optionally filtered by cabinet type
Free cabinets list 3 params → 200400401403

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Device (23 properties), DeviceHeartbeat (17 properties), DeviceResponse (16 properties), DeviceHeartbeatResponse (14 properties). Each schema is shown below with its type and property counts.

IDomainEvent
object
2 properties
DeviceEvent
object
5 properties
DeviceHeartbeatUserinfoResponse
object
6 properties
DeviceEventNotification
object
5 properties
TenantDevice
object
3 properties
DeviceSIMStatus
object
6 properties
Device
object
23 properties
DeviceRegistrationState
object
9 properties
CabinetProdData
object
8 properties
DeviceShelfStatus
object
10 properties
SendDeviceCommandRequest
object
1 property
Error
object
2 properties
CabinetType
integer
DedicatedDevicePreRegistrationRequest
object
1 property 1 required
DeviceHeartbeat
object
17 properties
DeviceType
integer
DeviceHeartbeatUserInfo
object
9 properties
DedicatedDevicePreRegistrationResponse
object
4 properties
DeviceResponseIPagedResult
object
5 properties
DeviceEventsResponse
object
4 properties
ProvisioningCabinetResponse
object
10 properties
DeviceUpdateRequest
object
2 properties
DevicePreRegistrationStatus
integer
DeviceResponse
object
16 properties
ApiErrorResponse
object
1 property
DeviceHeartbeatResponse
object
14 properties
NotificationsReceiver
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

invendor-devices-api-openapi.yml Raw ↑

Other APIs Invendor publishes across the network.

Invendor Accounts API
Invendor Auth API
Invendor Barcodes API
Invendor Consumption API
Invendor DataJobs API
Invendor Dimensions API
Invendor DimensionValues API
Invendor Doors API
Invendor DynamicScanContent API
Invendor ExtendedProperties API
Invendor FlagTypes API
Invendor GlobalSettings API