7.1 企业方API概览
萝卜头平台向企业配置的 URL 地址发送 HTTP[S] POST 或 GET 请求,并按照接口说明在请求中加入相应参数; 根据实际处理情况,企业方平台返回相应结果。
7.1.1 本页面列出了所有 API 接口
API | 描述 |
---|---|
auth_device | 向企业方鉴权设备 |
notify_device_service | 通知企业方开通设备云存储服务 |
7.1.2 请求结构
服务地址
URL 由企业方提供
协议:
支持HTTP, HTTPS。
请求方式:
支持 GET, POST
字符编码
请求及返回结果都使用 UTF-8 字符集进行编码
7.1.3 公共参数
请求参数 | 必须 | 字段类型 | 说明 |
---|---|---|---|
act | 是 | String | 用于标识请求 |
access_token | String | 是 | 受信访问令牌:由企业方生成,并校验有效性。建议采用OAuth2.0标准协议。 请参看OAuth标准(英文), OAuth维基百科(中文) |
响应参数 | 类型 | 描述 |
---|---|---|
ret | Int | 0:正常返回;非0时为错误值; |
msg | String | 描述 |
7.1.4 返回结果
JSON结构
成功结果
{
"ret": 0,
"msg": "ok",
}
错误结果
{
"ret": 1,
"msg": "error"
}
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及下述 公共错误码 来定位错误原因。