目睹有课API使用指南

API简介

有课开放API需要使用 ACCESS KEY 发起API请求，暂时只开放控制台能力，如有更多需求，请联系我们。申请API调用权限，请联系 4009-618-610。

API使用步骤

API的使用分为三步：

1.成为专业版用户，得到ACCESS KEY与SECRET KEY

2.所有请求中都必须包含access_key，timestamp（请求有课服务器当前时间戳），sign（签名串）三个参数

3.使用从有课得到的ACCESS KEY，便可以访问目睹API中的全部接口服务，如果请求没有带上ACCESS KEY，目睹有课API的安全机制将会视其为未授权访问操作，并将其拦截。

API域名

接口中变量youke-url代表：http://youke.mudu.tv

API请求示例

下面将用 控制台-部门-更新 接口做简单示例，演示如何生成sign签名串

1. 将所有请求参数，与access_key,secret_key,timestamp三个参数一起合并到一维数组中，并将所有的value转化为string类型

   array (size=7)
   'parent_id' => string '1448669' (length=7),
   'name' => string '中文斜杠/同时生效' (length=25),
   'id' => string '1455226' (length=7)
   'access_key' => string 'ACCESS_KEY' (length=10)
   'secret_key' => string 'SECRET_KEY' (length=10)
   'timestamp' => string '1528786704' (length=10)
   

2. 对该数组进行键名升序排序

   array (size=7)
   'access_key' => string 'ACCESS_KEY' (length=10)
   'id' => string '1455226' (length=32)
   'name' => string '中文斜杠/同时生效' (length=25),
   'parent_id' => string '1448669' (length=7),
   'secret_key' => string 'SECRET_KEY' (length=10)
   'timestamp' => string '1528786704' (length=10)
   

3. 将排序后的数组转换为json对象，注意不要将中文编码为UNICODE，不要将斜杠（/）转义

   {
    "access_key": "ACCESS_KEY",
    "id": "1455226",
    "name": "中文斜杠/同时生效",
    "parent_id": "1448669",
    "secret_key": "SECRET_KEY",
    "timestamp": "1528786704"
   }
   

4. sha1 算出sign签名串

   77e0461cf5af753a615aec855c3191f04dc7e415
   

API错误响应

错误响应消息

{
    "code": 错误码,
    "msg": "状态描述"
}

错误码对照表

400 Bad Request

400001 Invalid parameters
400002 Missing parameters

401 Unauthorized

401001 Unauthorized user

403 Forbidden

403001 Not allowed to access
403002 Permission not allowed

404 Not Found

404001 No such user
404002 No such activity
404003 No such video

405 Method Not Allowed

405001 Http method not allowed

429 Too Many Requests

429001 Touch rate limit

500 Internal Server Error

500001 Server logic error
500002 Internal server error