微吼开放平台
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
  1. 接入指南
  • 业务流程
  • 接入指南
  • 开通账号
  • 基本概念
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
  1. 接入指南

接入指南

接入指南#

微吼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
platform 15 为固定值, 请求发起时进行固定传参

request-id#

同时为了更好串联请求和排除定位问题, API请求发起方可以自定义跟踪ID请求,参数名request-id;
示例 : request_id : 24dDz3uDxVaqbSFycxnRGtQCq2vcov9x 表示每次请求唯一的请求标识,针对每次请求不可重复,调用方可随机生成;

字符编码#

请使用UTF-8编码

请求参数#

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

公共参数#

参数名类型必选说明
app_keystring是应用 key
sign_typeinteger否签名方式:0 - md5(默认)、1 - RSA
signed_atstring是签名时间戳,必传参数,取当前 UNIX 时间戳,单位为秒。
注意:如果与服务器时间相差超过5分钟,会提示签名过期报错。
signstring是签名数据值,生成方式见 : 签名机制

返回值#

所有返回值一律为JSON格式,返回的 HTTP 状态码为 200,代表调用成功。返回非 200 的 HTTP 状态码代表调用失败。
例如:
{
  "code": 200,
  "msg": "success",
  "data": {
    "user_id": 16417997
  }
}
上一页
业务流程
下一页
开通账号
Built with