Flexa partner portal implementation partner

Specification of the example partner portal hosted on https://portal.partner.com

Server

portal.partner.com

GetURL

This acts as a portal's device-facing endpoint (this will be called only if you passed 'completeUrl': 'https://portal.partner.com/GetURL' in AssignDevice flexa registry endpoint)

NOTE: You can even use a static json file with the response format.

Auth

Query String

regId

string

Device's registration ID (example - rd7JmLGdg5Rr)

GET /GetURL

xxxxxxxxxx
 
curl --get \ --url 'https://portal.partner.com/GetURL' \ --data regId={regId}
Copy

Responses application/json

200

Success

object	object
packageUrl	string	URL pointing to current version of the flexa package
version	integer	Version of the current flexa package (this is used to determine if device needs to update)
data	object	Any extra parameters (These will be pulled from portal on every boot of the device)
setStatusUrl	string	URL denoted with request method (GET/POST) to the SetStatus endpoint, to which the device will push it's state every x hours (this is defined in SetStatus itself)
getConfigUrl	string	URL denoted with request method (GET/POST) to the GetConfig endpoint, from where the device will pull it's config if needed (this is defined in SetStatus endpoint)
apiVersion	number	API version of the portal, currently defined version is 2

400

Failed

Response

xxxxxxxxxx
 
{ "packageUrl": "https://mifare.blob.core.windows.net/packages/Mifare212.zip", "version": 1, "data": {  "key1": "value1",  "key2": "value2" }, "setStatusUrl": "POST https://portal.partner.com/SetStatus", "getConfigUrl": "POST https://portal.partner.com/GetConfig", "apiVersion": 2}
Copy

GetURL

This acts as a portal's device-facing endpoint (this will be called only if you passed 'url': 'https://portal.partner.com' in AssignDevice flexa registry endpoint)

Auth

Request Body application/json

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

POST /GetURL

xxxxxxxxxx
 
curl --request POST \ --url 'https://portal.partner.com/GetURL' \ --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

Success

object	object
packageUrl	string	URL pointing to current version of the flexa package
version	integer	Version of the current flexa package (this is used to determine if device needs to update)
data	object	Any extra parameters (These will be pulled from portal on every boot of the device)
setStatusUrl	string	URL denoted with request method (GET/POST) to the SetStatus endpoint, to which the device will push it's state every x hours (this is defined in SetStatus itself)
getConfigUrl	string	URL denoted with request method (GET/POST) to the GetConfig endpoint, from where the device will pull it's config if needed (this is defined in SetStatus endpoint)
apiVersion	number	API version of the portal, currently defined version is 2

400

Failed

Response

xxxxxxxxxx
 
{ "packageUrl": "https://mifare.blob.core.windows.net/packages/Mifare212.zip", "version": 1, "data": {  "key1": "value1",  "key2": "value2" }, "setStatusUrl": "POST https://portal.partner.com/SetStatus", "getConfigUrl": "POST https://portal.partner.com/GetConfig", "apiVersion": 2}
Copy

SetStatus

Endpoint for posting device's status to the portal

Auth

Query String

regId	string	Device's registration ID (example - rd7JmLGdg5Rr)
status	string	Device's status (example - Alive)

GET /SetStatus

xxxxxxxxxx
 
curl --get \ --url 'https://portal.partner.com/SetStatus' \ --data regId={regId} \ --data status={status}
Copy

Responses application/json

200

Success

object	object
config	string	Three values are posible, 'new' - new config is available and the device should call GetConfig script; 'sync' - config is synchronized, no action needed; 'reboot' - new version of the application package is available on the cloud, so the device should perform reboot and update

400

Failed

Response

xxxxxxxxxx
 
{ "config": "new"}
Copy

SetStatus

Endpoint for posting device's status to the portal

Auth

Request Body application/json

object	object
regId	string	Device's registration ID
status	string	Device's status
info	object	Any other extra parameters about the current status

POST /SetStatus

xxxxxxxxxx
 
curl --request POST \ --url 'https://portal.partner.com/SetStatus' \ --data '{  "regId": "rd7JmLGdg5Rr",  "status": "Alive",  "info": {    "addInfo1": "value1",    "addInfo2": "value2"  }}'
Copy

Responses application/json

200

Success

object	object
config	string	Three values are posible, 'new' - new config is available and the device should call GetConfig script; 'sync' - config is synchronized, no action needed; 'reboot' - new version of the application package is available on the cloud, so the device should perform reboot and update

400

Failed

Response

xxxxxxxxxx
 
{ "config": "new"}
Copy

GetConfig

Endpoint for posting device's status to the portal

Auth

Query String

regId

string

Device's registration ID (example - rd7JmLGdg5Rr)

GET /GetConfig

xxxxxxxxxx
 
curl --get \ --url 'https://portal.partner.com/GetConfig' \ --data regId={regId}
Copy

Responses application/json

200

Success

object	object
UpdateRate	integer	Indicates how many hours to wait between contacting the portal (SetStatus endpoint)
AppParam	object	Device's desired configuration

400

Failed

Response

xxxxxxxxxx
 
{ "UpdateRate": 1, "AppParam": {  "key1": "value1",  "key2": "value2" }}
Copy

GetConfig

Endpoint for getting the desired config by the device

Auth

Request Body application/json

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

POST /GetConfig

xxxxxxxxxx
 
curl --request POST \ --url 'https://portal.partner.com/GetConfig' \ --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

Success

object	object
UpdateRate	integer	Indicates how many hours to wait between contacting the portal (SetStatus endpoint)
AppParam	object	Device's desired configuration

400

Failed

Response

xxxxxxxxxx
 
{ "UpdateRate": 1, "AppParam": {  "key1": "value1",  "key2": "value2" }}
Copy