Provisioning

Provisioning is a process of adding devices to the Enapter Platform.

Provision Lua Device CloudGateway

POST /v3/provisioning/lua_device

Adds a Lua device that implements integration with third-party devices using Lua scripts.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/lua_device \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "runtime_id": "6465fbad-7c71-4993-b4db-f0854548e585",
            "blueprint_id": "2f6c64fe-923b-4a43-a340-0ecf78eb8112",
            "name": "Gas sensor",
            "slug": "gas-sensor-1"
        }'

runtime_idstringrequired

UCM device ID where the new Lua device will run.

blueprint_idstringrequired

ID of blueprint to use to create the new Lua device.

namestringrequired

Device name.

slugstring

Device slug. Will be generated from name if omited.

Response

{
    "device_id": "e8f0345d-d050-4e9d-a52d-db2c00eecf64",
    "slug": "gas-sensor-1"
}

device_idstring

Device ID.

slugstring

Device slug.

Provision Standalone Device CloudGateway

POST /v3/provisioning/standalone

Adds an Enapter Standalone device to the Enapter Platform.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/standalone \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "site_id": "6d00215b-9523-498c-9172-aa68a67274a3",
            "name": "My Device"
        }'

site_idstringrequired

ID of the site.

namestringrequired

Device name.

Response

{
    "device_id": "e8f0345d-d050-4e9d-a52d-db2c00eecf64",
    "slug": "my-device",
    "config": {
        "mqtt_host": "mqtt.enapter.com",
        "mqtt_port": 8883,
        "mqtt_protocol": "MQTTS",
        "mqtt_credentials": {
            "private_key": "...",
            "certificate": "...",
            "ca_chain": "..."
        },
        "time_sync_protocol": "HTTP",
        "time_sync_host": "127.0.0.1",
        "time_sync_port": 80,
        "hardware_id": "C8795CBA5375484E829105E959663C8B",
        "channel_id": "ucm"
    }
}

device_idstring

Device ID.

slugstring

Device slug.

configobject

Object containing a device communication configuration information.

config.mqtt_hoststring

Enapter Cloud MQTT broker host.

config.mqtt_postinteger

Enapter Cloud MQTT broker port.

config.mqtt_protocolstring

MQTT or MQTTS.

config.mqtt_credentialsobject

Contains either MQTT or MQTTS protocol credentials.

MQTT	MQTTS
mqtt_credentials.usernamestring Enapter Cloud MQTT broker username.	mqtt_credentials.private_keystring Enapter Cloud MQTT broker private key.
mqtt_credentials.passwordstring Enapter Cloud MQTT broker password.	mqtt_credentials.certificatestring Enapter Cloud MQTT broker certificate.
	mqtt_credentials.ca_chainstring Enapter Cloud MQTT broker certificate chain.

config.time_sync_protocolstring

Time synchronization protocol.

config.time_sync_hoststring

Time synchronization host.

config.time_sync_portinteger

Time synchronisation server port.

config.hardware_idstring

Device hardware ID.

config.channel_idstring

Device channel ID.