OpenApi文档（由客户服务端调用）

v3文档 v3-open-api

说明

• 域名：https://api.fogcloud.io
• 文档中所有带token标注的接口需要在header中添加token；token需要放置在header的Authorization字段中，值为Bearer+空格+token，示例如下：

Authorization: Bearer Ks1B79H7FIlT36uT16zj...

• POST和PUT请求的参数需要封装到http请求的body中。
• GET和DELETE请求的参数需要拼接在URL中。

Token错误码

• token错误

{
    "meta":{
        "message":"token is error",
        "code":10101
    },
    "data":{
    }
}

• token过期

{
    "meta":{
        "message":"token is expired",
        "code":10100
    },
    "data":{
    }
}

获取访问Token

POST /v3/open_api/token/

• 获取访问OpenApi接口的Token，目前token有效期为7天，到期后请重新获取，可以通过token过期的错误码（10010）判断token是否失效。

请求参数

返回值

{
    "meta":{
        "message":"token info",
        "code":0
    },
    "data":{
        "access_token":"2cwO2K4FVynCWmG..",
        "token_type":"Bearer",
        "expires_in":604800,
        "scope":"read write groups"
    }
}

字段说明

Token使用说明

• token需要放置在header的Authorization中，字段值为Bearer+空格+token，示例如下：

Authorization: Bearer Ks1B79H7FIlT36uT16zj...

错误码

注册MQTT账户（token）

POST /v3/open_api/mqtt/client/

• 通过该接口可以注册一个MQTT账户，用于登录MQTT Server，接口返回的相关信息需要自行保存，不提供接口获取相关数据。

请求参数

返回值

{
    "meta":{
        "message":"mqtt info",
        "code":0
    },
    "data":{
        "loginname":"81579cea3a1811e7a554...",
        "sslport":1884,
        "clientid":"ce74f1686dde11e7a5...",
        "endpoint":"81579cea3a1811e...",
        "mqttport":1883,
        "password":"qNHS14x4/5Cseu2Ar...",
        "mqtthost":"81579cea3a1...mqtt.iot.gz.baidubce.com"
    }
}

字段说明

错误码

添加MQTT权限（token）

POST /v3/open_api/mqtt/permission/

• 为App用户添加设备的MQTT权限。

请求参数

返回值

{
    "meta":{
        "message":"create permission ok",
        "code":0
    },
    "data":{
        "client_id":"077254806...",
        "device_id":"83e134fa42bd11..."
    }
}

字段说明
无

错误码

删除MQTT权限（token）

DELETE /v3/open_api/mqtt/permission/

• 为App用户删除设备的MQTT权限，设备保留原有权限。

请求参数

返回值

{
    "meta":{
        "message":"delete permission ok",
        "code":0
    },
    "data":{
        "client_id":"077254806d1a...",
        "device_id":"83e134fa42bd..."
    }
}

字段说明
无

错误码

获取产品ID列表（token）

GET /v3/open_api/product/ids/

• 获取用户名下的所有产品ID和产品名字。

请求参数
无

返回值

{
    "meta":{
        "message":"product id list",
        "code":0
    },
    "data":[
        {
            "productid":"f164aaf856f...",
            "pname":"test101702"
        },
        {
            "productid":"b67741acb2f...",
            "pname":"test101701"
        }
    ]
}

字段说明
无

错误码