Gateway Device Management API

Jan 1 2022 at 12:00 AM

APIs within the Gateway Device Management API

The Raptor™ gateway device API’s are responsible for data aggregation and collection from devices on the edge.

APIs within the Gateway Device Management API

Authorize

Allows you to authenticate with the Collector service.

API Calls

RequestAccessToken

Request a Bearer token from the Collector service to use for API calls.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Authorize/RequestAccessToken

URL Params

none

Data Params

{
  "ServiceId": "MyServiceId",
  "Signature": "WSjIXxDOmVM7u1KGxabqNx18iw+HfMl ... KcopV+kDBcRI1YY5Zqi50MbdAyotshQ=="
}

Success Response

Response message with the following codes and JSON body formats.Refer to the API Response Types Success Response

{
  "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6I ... ArzjWdfsMQyReRZhcoqmrA",
  "tokenType": "Bearer",
  "isError": false,
  "error": null
}

Notes

None

Device

Allows you to manage the Devices that the Raptor™ controls.

API Calls

Get

Gets the list of the Devices that the raptor currently controls.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Device/Get

URL Params

none

Data Params

none

Success Response

A response containing the list of Devices

{
  "devices": [
    {
      "GatewayId": "demo.raptor.iotnxt.io",
      "DeviceName": "WeatherStation",
      "GroupName": "Environment",
      "DeviceType": "Weather",
      "DisplayName": "Weather Station",
      "Make": "IoT.nxt",
      "Model": "Weather Device A",
      "ServiceId": "weather.raptor.ionxt.io",
      "ServiceVersion": "4.0.16.1-alpha-001",
      "TransmitFlag": null
    }
  ],
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Get

Gets the list of the Devices associated with the specified Gateway.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Device/Get

URL Params

none

Data Params

{
  "GatewayId": "demo.raptor.iotnxt.io"
}

Success Response

A response containing the list of Devices

{
  "devices": [
    {
      "GatewayId": "demo.raptor.iotnxt.io",
      "DeviceName": "WeatherStation",
      "GroupName": "Environment",
      "DeviceType": "Weather",
      "DisplayName": "Weather Station",
      "Make": "IoT.nxt",
      "Model": "Weather Device A",
      "ServiceId": "weather.raptor.ionxt.io",
      "ServiceVersion": "4.0.16.1-alpha-001",
      "TransmitFlag": null
    }
  ],
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Update

Updates the specified device information.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Device/Update

URL Params

none

Data Params

The device information to update.

{
  "GatewayId": "demo.raptor.iotnxt.io",
  "DeviceName": "WeatherStation",
  "GroupName": "Environment",
  "DeviceType": "Weather",
  "DisplayName": "Weather Station",
  "Make": "IoT.nxt",
  "Model": "Weather Model A"
}

Success Response

A response showing if any error occurred

{
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Delete

Deletes the specified device and all associated properties.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Device/Delete

URL Params

none

Data Params

The device information to delete.

{
  "GatewayId": "demo.raptor.iotnxt.io",
  "DeviceName": "WeatherStation",
  "GroupName": "Environment",
  "DeviceType": "Weather"
}

Success Response

A response showing if any error occurred

{
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Gateway

Allows you to manage the Gateways that the Raptor™ controls.

API Calls

Get

Gets the list of the Gateways that the raptor currently controls.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Gateway/Get

URL Params

none

Data Params

none

Success Response

A response containing the list of Gateways

{
  "gateways": [
    {
      "GatewayId": "demo.raptor.iotnxt.io",
      "Make": "Raptor",
      "Model": "VRaptor",
      "DisplayName": "Raptor Gateway",
      "ServiceVersion": "4.0.16.1-alpha-001",
      "Location": "Server Room A"
    }
  ],
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Update

Updates the specified gateway information.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Gateway/Update

URL Params

none

Data Params

The gateway information to update.

{
  "GatewayId": "demo.raptor.iotnxt.io",
  "Make": "Raptor",
  "Model": "VRaptor",
  "DisplayName": "Raptor Gateway",
  "Location": "Server Room A"
}

Success Response

A response showing if any error occurred

{
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Delete

Deletes the specified gateway and all associated devices and properties.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Gateway/Delete

URL Params

none

Data Params

The gateway to delete.

{
  "GatewayId": "demo.raptor.iotnxt.io"
}

Success Response

A response showing if any error occurred

{
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Property

Allows you to manage the Properties for a Device.

API Calls

Get

Gets the list of the Properties for the specified Device.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Property/Get

URL Params

none

Data Params

The device information.

{
  "GatewayId": "demo.raptor.iotnxt.io",
  "DeviceName": "WeatherStation",
  "GroupName": "Environment",
  "DeviceType": "Weather"
}

Success Response

A response containing the list of Devices

{
  "properties": [
    {
      "GatewayId": "demo.raptor.iotnxt.io",
      "DeviceName": "WeatherStation",
      "GroupName": "Environment",
      "DeviceType": "Weather",
      "PropertyPathKey": "Temperature",
      "DisplayName": "External Temperature",
      "PropertyDescription": "Outdoor Temperature",
      "DataType": "Double",
      "TransmitFlag": 1
    },
    {
      "GatewayId": "demo.raptor.iotnxt.io",
      "DeviceName": "WeatherStation",
      "GroupName": "Environment",
      "DeviceType": "Weather",
      "PropertyPathKey": "Humidity",
      "DisplayName": "External Humidity",
      "PropertyDescription": "Outdoor Humidity",
      "DataType": "Double",
      "TransmitFlag": 1
    }
  ],
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Update

Updates the specified property information.

Permission

Bearer or API Key required

URL

https://community-vraptor.iotnxt.io/api/Property/Update

URL Params

none

Data Params

The property information to update.

{
  "GatewayId": "demo.raptor.iotnxt.io",
  "DeviceName": "WeatherStation",
  "GroupName": "Environment",
  "DeviceType": "Weather",
  "PropertyPathKey": "Temperature",
  "DisplayName": "External Temperature",
  "PropertyDescription": "Outdoor Temperature",
  "DataType": "Double",
  "TransmitFlag": 1
}

Success Response

A response containing the list of Devices

{
  "isError": false,
  "error": null
}

Error Response

401 - An invalid, expired or missing Bearer token was provided

Notes

None

Graphs

API Calls

metricsGraphs

Permission

No permissions check

URL

https://community-vraptor.iotnxt.io/metricsGraphs

URL Params

none

Data Params

none

Success Response

200 - A response containing the list of Devices

none

Notes

None

updateData

Permission

No permissions check

URL

https://community-vraptor.iotnxt.io/metricsGraphs/updateData

URL Params

none

Data Params

none

Success Response

200 - A response containing the list of Devices

none

Notes

None

Gateway Device Management API

APIs within the Gateway Device Management API

Authorize

API Calls

Device

API Calls

Gateway

API Calls

Property

API Calls

Graphs

API Calls

Continue reading

Community

Questions

Website