IoT Stadium

API Documentation

BLE Gateway

BLE Gateway - POST Add BLE Gateway (LoRaWAN)

Adding BLE gateway that uses LoRaWAN protocol

Post
{{url_iot_backend}}/ext/ble-gateway
{
    "key": "Content-Type",
    "value": "application/json"
},
{
    "key": "Authorization",
    "value": "Bearer {{token}}"
}

Parameter

Field Type Description
gateway_name String

Name of the BLE Gateway (required)

frequency_plan_id String

The ID of the frequency plan of your BLE gateway (required | this data is taken from the list of API Frequency Plan)

gateway_id String

The ID of your BLE gateway

token String

The token of your BLE Gateway

description String

The description of your BLE Gateway

connectivity_type Integer

The ID of the connectivity type of your BLE Gateway

deveui String

The DevEUI of your BLE Gateway

device_network Integer

The ID for your device network (required | this is taken from the list of device network)

join_eui String

The JoinEUI of your BLE Gateway (required)

app_key String

The App Key of your BLE Gateway (required)

lorawan_version_mac String

The MAC version of your BLE Gateway (required | this is taken from list of LoRaWAN version)

lorawan_phy_version String

The ID of the LoRaWAN phy version of your BLE Gateway (required | this is taken from list of phy version)

downlink_encoder String

The downlink encoder of your BLE Gateway

uplink_decoder String

The uplink decoder of your BLE Gateway

gateway_image_default String

The code of your BLE Gateway

connectivity_type_id Intger

The ID of the connectivity type of your BLE Gateway

gateway_network_id Integer

The ID of your BLE Gateway

location_id Integer

The ID for your the assigned location for your BLE Gateway

location_custom_field Array

The additional detail of your location

{
    "gateway_name": "Etest ble gateway lorawan type",
    "frequency_plan_id": "EU_863_870", 
    "gateway_id": null,
    "token": null,
    "description": "Aliquid atque dolore",
    "connectivity_type": 3,
    "deveui": "1234567891123456",
    "device_network": 2, 
    "join_eui": "1234567891123456",
    "app_key": "2131231231dadadadade21381d812edd",
    "lorawan_version_mac": "MAC_V1_0",
    "lorawan_phy_version": "PHY_V1_0",
    "downlink_encoder": "test",
    "uplink_decoder": "test",
    "gateway_image_default": null,
    "connectivity_type_id": 3,
    "gateway_network_id": 2,
    "location_id": 169,
    "location_custom_field": [
        {
            "location_custom_field_id": 266,
            "value": "gedung A"
        }
    ]
}                                            
{
    "message": "ble_gateway created",
    "data": {
        "id": 53
    },
    "code": 200
}
{
    "message": "Invalid Message",
    "code": 400,
    "errors": [
        {
            "field": "deveui",
            "message": "The deveui format is invalid."
        },
        {
            "field": "join_eui",
            "message": "The join eui format is invalid. The join eui may not be greater than 16 characters."
        }
    ]
}