说明
服务器出厂有个默认admin用户,用户名和密码都是admin,可以通过admin创建其他用户,创建的用户可以用过用户名和密码登录
在您使用任何本文档所描述的HTTP API之前,您必须先获得使用HTTP API的授权。
语音对讲服务器授权的机制简单描述如下:
1) 首先,您需要提供一个有效的用户名和密码,语音对讲服务器需要校验您的用户名和密码的合法性;
2) 如果您的用户名和密码校验正确,语音对讲服务器将为您生成一对随机的Authorization Token和返回用户角色和用户昵称,并在响应中返回给您。
3) 您必须记录Authorization Token。在您接下来的每一个HTTP API请求中,您都必须传递Authorization Token在HTTP的请求Headers或参数中。这有三种可选择的传递方式:
- 通过HTTP GET/POST参数;
- 通过HTTP Headers字段;
- 通过HTTP Cookie。
授权本身也是一个HTTP API,不过它与其它的API不同之处在于,它不检查和校验 Session ID 和 Authorization Token,而是通过检查您提交的用户名和密码来为您生成Session ID和Authorization Token。
API URL
/intercom/user/login.json
Request
Method:GET/POST
参数 | Value | 说明 |
---|---|---|
username | [STRING] ,Required | 请求授权的有效用户名。 |
pwd | [STRING] ,Required | 请求授权用户的密码。 |
type | [STRING] ,Required | 用户类型 如:user |
Response
格式(Example):
{
"result":"ok",
"data":{
"role_id":"admin",
"token":"ZIK48H80V32Y17R0IBZA8F4P3AGCGF2F",
"alias":"admin"
}
}
Data字段说明:
Field | Value | 说明 |
---|---|---|
role_id | [STRING] | 用户角色。 |
alias | [STRING] | 用户别名。 |
token | [STRING] | 随机的Authorization Token。 并在后续其它的HTTP API请求中传递这个值。 |
一些建议:
1) 提醒您注意!用户默认有个admin用户,该用户有管理员权限,不能修改其权限,但可以修改密码。