公共头域

公共请求头域

公共参数是用于标识用户和接口签名的参数，如非必要，在每个接口单独的接口文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求。

公共头域	类型	必选	说明
Host	String	是	服务域名，目前固定为 bayer-rts-console-api.cloudhub.vip
Authorization	String	是	Bearer token签名串。
Content-Type	String	是	multipart/form-data;
Content-Length	String	否	用于描述HTTP消息实体的传输长度

HTTP POST （multipart/form-data）请求结构示例：

POST /record/start HTTP/1.1
Host: bayer-rts-console-api.cloudhub.vip
Authorization: Bearer token请求签名串
Content-Length: 283
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="app_id"

app_id 参数值
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="stream_url"

stream_url 参数值
----WebKitFormBoundary7MA4YWxkTrZu0gW

token 签名串

请求类型都为 POST 请求, token 签名串调用不用添加公共头域中的 Authorization, 请求此 token 签名串接口域名跟公共头部中 Host 有所区别

接口地址

https://bayer-api.cloudhub.vip/auth/login/access_key

参数

参数	类型	必选	说明
access_key_id	String	是	请联系管理员获取
access_key_secret	String	是	请联系管理员获取

HTTP POST （multipart/form-data）请求结构示例：

POST /auth/login/access_key HTTP/1.1
Host: bayer-api.cloudhub.vip
Content-Length: 278
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="access_key_id"

access_key_id 参数值
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="access_key_secret"

access_key_secret 参数值
----WebKitFormBoundary7MA4YWxkTrZu0gW

返回值

http 返回 200 状态码,获取 json 内容结构如下:

{
    "data": {
        "type": "<bearer>",
        "expires_in": "<失效时长, 建议设置本地 token 失效时间, 604800(秒)>",
        "access_token": "<token请求签名串,并赋值到公共头域 Authorization 中>"
    }
}

状态码

http 状态码说明

状态码	说明
200	服务器成功
401	未授权
404	请求地址不存在
422	请求参数或者格式错误
500	服务器内部错误

状态内容参考

http 返回 401 状态码,获取 json 内容结构如下:

{
    "message": "unauthorized",
    "status_code": 401,
}

http 返回 404 状态码,获取 json 内容结构如下:

{
    "message": "404 Not Found",
    "status_code": 404,
}

http 返回 422 状态码,获取 json 内容结构如下:

{
    "errors":{

    }
    "message": "The given data was invalid.",
    "status_code": 422,
}

http 返回 500 状态码后,获取 json 内容结构如下:

{
    "code":"500"
    "message": "internal error",
    "status_code": 500,
}