快速接入

接入指南

微吼 SAAS API 是基于微吼 SAAS 平台提供便捷接入、功能全面、性能稳定、方式灵活服务。您可以通过 SAAS API，依照文档与自己服务进行集成，定制属于您自己的直播服务。SAAS API 平台让您告别复杂的架构设计和编程开发，使您可以专注于业务逻辑实现及最终用户体验的提升

接入前提

确认您已完成开放平台权限及账号的申请,并创建应用，如未完成请先完成开通账号/权限

API 请求域名

https://saas-open.vhall.com

接口拼接方式

URL 请求接口：{域名} {业务接口地址}

示例：
业务接口地址：/v3/users/open-user/info
拼接后接口 URL：https://saas-open.vhall.com/v3/users/open-user/info

通信协议

请求支持 HTTPS 访问

请求方法

GET 方式查询字符串（名称/值对）是在 GET 请求的 URL 中发送的；

POST 方式查询字符串（名称/值对）是在 POST 请求的 HTTP 消息主体中发送的。

请求头

为明确请求来源 , 请在每次 API 请求的请求头部增加请求头参数platform , 固定值为15 , 且为了更好串联请求和排除定位问题, API 请求发起方可以自定义请求id , 参数名request-id , 表示每次请求唯一的请求标识,针对每次请求不可重复,调用方可随机生成;

请求编码格式

请求编码格式如接口无特殊说明 , 默认使用 :

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

请求参数

每个请求，都需要包含公共请求参数、接口业务参数。

字符编码

请使用 UTF-8 编码

公共请求参数

参数名	类型	必选	说明
app_key	string	是	应用 key
signed_at	string	是	签名时间戳，必传参数，取当前 UNIX 时间戳，单位为秒。注意：如果与服务器时间相差超过 5 分钟，会提示签名过期报错。
sign_type	integer	否	签名方式：0=md5(默认)、1=RSA、2=SHA256、3=SM3
sign	string	是	签名数据值，生成方式见签名示例

返回值

所有返回值一律为 JSON 格式，返回的 HTTP 状态码为 200，代表调用成功。返回非 200 的 HTTP 状态码代表调用失败。形如：

错误码

错误码请参照全局错误码

接入指南#

接入前提#

API 请求域名#

接口拼接方式#

通信协议#

请求方法#

请求头#

请求编码格式#

请求参数#

字符编码#

公共请求参数#

返回值#

错误码#