Integrator best practices #

Use built-in metadata storage for device #

The device object have a limited size external field. This can be used for a integrator json object. This allows the integrator to avoid having it’s own device database. And can simplify design.

Set this field:

curl -H "X-API-Key: <api key>" -X PUT -H "Content-Type: application/json" \
    -d '{"customer":"customer1","group":"group1"}' \
    https://api.nr.iotready.no/api/v1/device/<dev_id>/external

The devices endpoint allows queries using external fields:

curl -H "X-API-Key: <api key>" \
    "https://api.nr.iotready.no/api/v1/devices?external.group=group1"