3 使用说明

3.1 登录

科达视讯平台API采用统一登陆方式对软件权限及用户账户进行验证，使用者仅需登陆一次，便可调用各子系统的API。

使用者需先申请一个API

License，并导入到科达视频会议系统中，其中包含软件key和密钥。

通过软件key+密钥向平台注册获取account_token

POST /api/v1/system/token HTTP/1.1

Accept-Encoding: identity

Content-Length: 58

Host: 127.0.0.1

User-Agent: Python-urllib/3.5

Content-Type: application/x-www-form-urlencoded

Connection: close

oauth_consumer_key=key&oauth_consumer_secret=12345678

HTTP/1.1 200 OK

Server: nginx

Date: Mon, 27 Jun 2016 07:39:49 GMT

Content-Type: application/json; charset=UTF-8

Content-Length: 67

Connection: close

{"success": 1, "account_token": "6567e24b425db665a3044db69f0c6fe4"}

二次开发通过account_token + 帐号 + 密码登录

POST /api/v1/system/login HTTP/1.1

Accept-Encoding: identity

Content-Length: 85

Host: 172.16.185.146

User-Agent: Python-urllib/3.5

Content-Type: application/x-www-form-urlencoded

Connection: close

password=888888&username=name&account_token=6567e24b425db665a3044db69f0c6fe4

HTTP/1.1 200 OK

Server: nginx

Date: Mon, 27 Jun 2016 07:39:49 GMT

Content-Type: application/json; charset=UTF-8

Content-Length: 43

Connection: close

Set-Cookie: SSO_COOKIE_KEY=890db118-9033-4317-8fe5-7456913d5793;

Expires=Mon, 11-Jul-2016 07:39:49 GMT;

{"success": 1, "username": "0512110001003"}

平台回复会将登录信息写入cookies中。

后续请求，二次开发者需要在每次请求的时候携带account_token+cookies来进行操作。

对于客户端无法自动处理cookie的，需要将登录的cookie保存起来，后续请求通过设置Http的Cookie字段，手动设置

平台会验证开发者权限以及用户权限。

每次请求会刷新token存活时间，若无操作，开发者需要自行调用接口刷新token存活时间。

3.2 获取类请求

参数平铺跟在URI后面，以&区分多参数

范例(获取会议列表为例)

GET /api/v1/vc/confs?account_token=6567e24b425db665a3044db69f0c6fe4 HTTP/1.1

Accept-Encoding: identity

User-Agent: Python-urllib/3.5

Host: 127.0.0.1

Cookie: SSO_COOKIE_KEY=890db118-9033-4317-8fe5-7456913d5793

Connection: close

3.3 修改类请求(POST PUT)

参数以表单形式提交，字符编码utf-8

Content-Type: application/x-www-form-urlencoded;charset=utf-8;

json类参数，以params作为key，json内容urlencoder后作为value进行传递。

范例 (添加终端为例)

POST /api/v1/vc/confs/1118986/mts HTTP/1.1

Accept-Encoding: identity

User-Agent: Python-urllib/3.5

Cookie: SSO_COOKIE_KEY=890db118-9033-4317-8fe5-7456913d5793

Content-Length: 305

Host: 127.0.0.1

Content-Type: application/x-www-form-urlencoded

Connection: close

params=%7B%22mts%22%3A+%5B%7B%22account_type%22%3A+5%2C+%22account

%22%3A+%222322231%22%2C+%22bitrate%22%3A+2048%2C+%22protocol%22%3A

+0%7D%2C+%7B%22account_type%22%3A+5%2C+%22account%22%3A+%222322232

%22%2C+%22bitrate%22%3A+2048%2C+%22protocol%22%3A+0%7D%5D%7D&

account_token=6567e24b425db665a3044db69f0c6fe4

3.4 答复

任何操作都有success标识成功失败

失败操作统一用error_code标识错误码

数据形式为json，字符编码utf-8

Content-Type: application/json;charset=utf-8;

范例(添加终端回复为例)

HTTP/1.1 200 OK

Server: nginx

Date: Mon, 27 Jun 2016 07:52:28 GMT

Content-Type: application/json; charset=UTF-8

Content-Length: 31

Connection: close

{"success": 1, "error_code": 0}