Vendor Connector Plugin API

REQUEST HEADERS

Key

Value

Content-Type

application/json

Content-Encoding1

gzip

Connection2

keep-alive

Api-Key

Vendor-defined API Key

Accept3

applicaton/json

REQUEST PAYLOAD

Payload is the beacon content. The beacon payload is aggregated and compressed.

RESPONSE PAYLOAD

Response payload is empty.

RESPONSE CODE

Status Code

Response

2XX

Success (recommended 200)

401

Authorization Error (Unauthorized)

404

Not found

500

Critical Server Error

Other responses are not explicitly handled by the Ruckus IoT Controller Connector.

Example CURL

curl -X POST -H “Content-Type: application/json” -H “Content-Encoding: gzip” -H “Api-Key: {api-key}” -d ‘<REQUEST PAYLOAD>’ {HOST}

1

Gzip compression is used to compress the complete beacon payload.

2

This is not mandatory and keep-alive will not be enabled for asynchronous requests.

3

This is not mandatory because a response payload from the vendor responses is not expected.