1. 功能说明

用于用户功能服务的授权增加、授权查询,以及访问控制列表的设置与查询等

2. 协议设计原则

  • 简化原则,目前统一使用POST方法
  • 采用json文本协议,保证协议可读性高和扩展性
  • 不添加额外的HTTP头部信息,只使用标准HTTP头部信息
  • 所有的参数都在http的body部分
  • json内容主要分header和body两部分,最上层为具体服务的缩写,本服务为AMS
  • 所有的字段类型为string

3. 调用地址

POST https://ams.wonlycloud.com:10200

4. 消息类型定义

定义 描述
MSG_TOKEN_ADD_REQ 请求获取Token
MSG_TOKEN_ADD_RSP 应答获取Token
MSG_TOKEN_DEL_REQ 请求删除Token
MSG_TOKEN_DEL_RSP 应答删除Token
MSG_TOKEN_QUERY_REQ 请求查询Token
MSG_TOKEN_QUERY_RSP 应答查询Token
MSG_TOKEN_GET_EX_REQ 请求查询服务商的Token
MSG_TOKEN_GET_EX_RSP 应答查询服务商的Token

5. 协议详解

每条协议都包含请求应答示例、请求参数说明、应答参数说明三个部分

5.1 获取Token

  • 请求应答示例

MSG_TOKEN_ADD_REQ

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "18888888888",
            "secret_key": "xxxxxxxxx",
            "attitude": "write"
        }
    }
}

MSG_TOKEN_ADD_RSP

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "token": "xxxxxxxxxxx"
        }
    }
}
参数 选项 说明 备注
username 必填 用户名 必须为11位手机号
secret_key 必填 用户密钥 UMS返回的用户密钥
attitude 必填 授权属性 read write
参数 说明 备注
token 授权令牌 设备访问其他服务所需的令牌

5.2 删除Token

  • 请求应答示例

MSG_TOKEN_DEL_REQ

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "18888888888",
            "secret_key": "xxxxxxxxx",
            "token": "xxxxxxxxxxx"
        }
    }
}

MSG_TOKEN_DEL_RSP

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
username 必填 用户名 必须为11位手机号
secret_key 必填 用户密钥 UMS返回的用户密钥
token 必填 授权令牌 设备访问其他服务所需的令牌

5.3 查询Token

  • 请求应答示例

MSG_TOKEN_QUERY_REQ

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "18888888888",
            "secret_key": "xxxxxxxxx",
            "token": "xxxxxxxxxxx"
        }
    }
}

MSG_TOKEN_QUERY_RSP

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "username": "18888888888",
            "attitude": "write"
        }
    }
}
参数 选项 说明 备注
username 必填 用户名 必须为11位手机号
secret_key 必填 用户密钥 UMS返回的用户密钥
token 必填 授权令牌 设备访问其他服务所需的令牌
参数 说明 备注
username 用户名 必须为11位手机号
attitude 授权属性 read write

5.4 查询服务商的Token

  • 请求应答示例

MSG_TOKEN_GET_EX_REQ

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_GET_EX_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "18888888888",
            "secret_key": "xxxxxxxxx",
            "vendor_name": "ys7",
            "getflag":"reget"
        }
    }
}

MSG_TOKEN_GET_EX_RSP

{
    "AMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TOKEN_GET_EX_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "accessToken": "XXXXXXXXXXXXXX",
            "expire_time": "xxxxxxxxx"
        }
    }
}
参数 选项 说明 备注
username 必填 用户名 必须为11位手机号
secret_key 必填 用户密钥 UMS返回的用户密钥
vendor_name 必填 供应商名称 公共参数,供应商名称,如:海康萤石ys7
getflag 选填 获取标志 使用萤石的token,萤石SDK返回token失效的情况下,APP端加上该字段,重新从萤石平台获取新的token,该情况下为必填。reget
参数 说明 备注
accessToken 授权令牌 对设备做其他一些操作需要的令牌
expire_time 过期时间 截至时间