Flexa Registry 1.0.0

Flexa registry offers https API endpoints for device assignment to partner's portal and for device to pull it's desired portal data.

Server

flexa-base.azurewebsites.net

AssignDevice

Assigns a device to be used with partner's portal

NOTE: If you don't specify 'url' parameter nor 'completeUrl' the device will be unassigned!

Auth

Query String

key	string	Partner's API key (example - 1RMq3ixf4uM6pTZi)
regId	string	Device's registration ID (example - rd7JmLGdg5Rr)
url	string	Root URL pointing to desired service, root URL must contain "GetURL" script and must accept POST requests
completeUrl	string	Exact URL pointing to desired partner side script/file accepting GET requests

GET /AssignDevice

xxxxxxxxxx
 
curl --get \ --url 'https://flexa-base.azurewebsites.net/api/AssignDevice' \ --data key={key} \ --data regId={regId} \ --data url={url} \ --data completeUrl={completeUrl}
Copy

Responses text/plain

200

Success

No response body

400

Request param missing

403

Auth failed

404

Device not found

405

Unassign failed: auth failed

406

Device already assigned

500

Internal database error

Response

xxxxxxxxxx
 
No response
Copy

AssignDevice

Assigns a device to be used with partner's portal

NOTE: If you don't specify 'url' parameter nor 'completeUrl' the device will be unassigned!

Auth

Request Body application/json

object	object
key	string	Partner's API key
regId	string	Device's registration ID
url	string	Root URL pointing to desired service, root URL must contain "GetURL" script and must accept POST requests
completeUrl	string	Exact URL pointing to desired partner side script/file accepting GET requests
extra	object	Any extra one-time setup parameters

POST /AssignDevice

xxxxxxxxxx
 
curl --request POST \ --url 'https://flexa-base.azurewebsites.net/api/AssignDevice' \ --data '{  "key": "1RMq3ixf4uM6pTZi",  "regId": "rd7JmLGdg5Rr",  "url": "https://barixiotnew.azurewebsites.net/api",  "completeUrl": "https://barixiot.blob.core.windows.net/scripts/mifare.json",  "extra": {    "key1": "value1",    "key2": "value2"  }}'
Copy

Responses text/plain

200

Success

No response body

400

Request param missing

403

Auth failed

404

Device not found

405

Unassign failed: auth failed

406

Device already assigned

500

Internal database error

Response

xxxxxxxxxx
 
No response
Copy

AssignDeviceBatch

Assigns list of devices to be used with partner's portal

NOTE: If you don't specify 'url' parameter nor 'completeUrl' the devices will be unassigned!

Auth

Request Body application/json

object	object
key	string	Partner's API key
regId	array[string]	Devices registration IDs
url	string	Root URL pointing to desired service, root URL must contain "GetURL" script and must accept POST requests
completeUrl	string	Exact URL pointing to desired partner side script/file accepting GET requests
extra	object	Any extra one-time setup parameters

POST /AssignDeviceBatch

xxxxxxxxxx
 
curl --request POST \ --url 'https://flexa-base.azurewebsites.net/api/AssignDeviceBatch' \ --data '{  "key": "1RMq3ixf4uM6pTZi",  "regId": "rd7JmLGdg5Rr",  "url": "https://barixiotnew.azurewebsites.net/api",  "completeUrl": "https://barixiot.blob.core.windows.net/scripts/mifare.json",  "extra": {    "key1": "value1",    "key2": "value2"  }}'
Copy

Responses application/json

200

Registration IDs of successfully assigned/unassigned

array array[string]

400

Malformed request body / Request param missing

403

Auth failed

500

Internal database error

Response

xxxxxxxxxx
 
rd7JmLGdg5Rr
Copy

DeviceGet

Device facing endpoint for getting desired service's urls and extra parameters (if defined)

NOTE: If you don't specify 'url' parameter nor 'completeUrl' the devices will be unassigned!

Auth

Query String

regId

string

Device's registration ID (example - rd7JmLGdg5Rr)

GET /DeviceGet

xxxxxxxxxx
 
curl --get \ --url 'https://flexa-base.azurewebsites.net/api/DeviceGet' \ --data regId={regId}
Copy

Responses application/json

200

Device data

object	object
url	string	Root URL pointing to desired service, root URL must contain "GetURL" script and must accept POST requests
completeUrl	string	Exact URL pointing to desired partner side script/file accepting GET requests
extra	object	Any extra one-time setup parameters

400

Device not assigned

404

Device not found

Response

xxxxxxxxxx
 
{ "url": "https://barixiotnew.azurewebsites.net/api", "completeUrl": "https://barixiot.blob.core.windows.net/scripts/mifare.json", "extra": {  "key1": "value1",  "key2": "value2" }}
Copy

DeviceGet

Device facing endpoint for getting desired service's urls and extra parameters (if defined)

NOTE: If you don't specify 'url' parameter nor 'completeUrl' the devices will be unassigned!

Auth

Request Body application/json

object	object
regId	string	Device's registration ID
DeviceInfo	object	Device info in form [name]:[value]

POST /DeviceGet

xxxxxxxxxx
 
curl --request POST \ --url 'https://flexa-base.azurewebsites.net/api/DeviceGet' \ --data '{  "regId": "rd7JmLGdg5Rr",  "DeviceInfo": {    "Address eth0.2@eth0": "192.168.3.163",    "Address lo": "127.0.0.1",    "Firmware version": "0.3"  }}'
Copy

Responses application/json

200

Device data

object	object
url	string	Root URL pointing to desired service, root URL must contain "GetURL" script and must accept POST requests
completeUrl	string	Exact URL pointing to desired partner side script/file accepting GET requests
extra	object	Any extra one-time setup parameters

400

Device not assigned

404

Device not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "url": "https://barixiotnew.azurewebsites.net/api", "completeUrl": "https://barixiot.blob.core.windows.net/scripts/mifare.json", "extra": {  "key1": "value1",  "key2": "value2" }}
Copy