H5直接嵌入

先决条件

已开通小鹅通SDK服务

已开通对应接口的小鹅通API服务

本教程所涉及的接口都先要获得access_token

获取access_token。(获取access_token前需要配置IP白名单, 详情请查看开发指南)

用户注册

时序图

接口请求

接口文档详见注册新用户

用户登录（无登录态）

时序图

配置跳转登录页

为什么配置跳转登录页

实现客户侧和小鹅侧的账号打通，小鹅通的获取登录链接接口需传递 user_id 参数，指定登录的具体用户。用户未登录时，跳转到配置的登录页，引导用户先在客户侧登录获取user_id，然后再调用小鹅的注册接口进行注册，获取小鹅侧的user_id，从而实现两端的账号数据关联

客户可在配置的登录页实现自己个性化的登录逻辑。

App内嵌webSDK，需要在访问小鹅通内嵌SDK页面的header头添加指定的user-agentXiaoeEmbed 。当访问的页面没有登录态时，小鹅平台会根据指定的user-agent跳转到客户配置的登录页面

配置

跳转登录页需联系服务管家进行配置,目前不能自行配置.

SDK-URL链接配置规则

店铺首页：https://.[h5或pc].xiaoeknow.com 其他页面：通过小鹅店铺管理台以下路径“课程管理-图文(课程类型，以图文为例)-点击某个具体的课程分享按钮-点击复制按钮” 得到链接 https://wxbe1b550e2f0d61db.h5.xiaoe-tech.com/v1/course/text/i_5e7f809dd6317_qSMuUoAi?type=2 SDK展示链接需要替换链接域名部分为.[h5或pc].xiaoekonow,例如，您的appid参数为”apprnDA0ZDw4581”，那么适配SDK展示的链接如下: https://apprnDA0ZDw4581.[h5或pc].xiaoeknow.com/v1/course/text/i_5e7f809dd6317_qSMuUoAi?type=2

以下是常用课程链接配置规则：

图文：https://{appid}.[h5或pc].xiaoeknow.com/v1/course/text/{idxxxxxx}?type=2

音频：https://{appid}.[h5或pc].xiaoeknow.com/v1/course/audio/{idxxxxxx}?type=2

视频：https://{appid}.[h5或pc].xiaoeknow.com/v1/course/video/{idxxxxxx}?type=2

直播：https://{appid}.[h5或pc].xiaoeknow.com/v2/course/alive/{idxxxxxx}?type=2

专栏：https://{appid}.[h5或pc].xiaoeknow.com/v1/course/column/{idxxxxxx}?type=3

会员：https://{appid}.[h5或pc].xiaoeknow.com/v1/course/member/{idxxxxxx}?type=3

获取登录鉴权链接

请求方式: POST

请求url: https://api.xiaoe-tech.com/xe.login.url/1.0.0

请求参数

参数名称	必选	类型	说明
access_token	是	string	接口调用凭据
user_id	是	string	用户id
data.login_type	是	登录类型：1:pc 2:h5 3:App	""
data.redirect_uri	否	string	登录成功后跳转的目标url

参数说明

redirect_uri可以是客户的店铺主页（比如https://appakkybt0j5197.h5.xiaoeknow.com），或者是具体的某个资源（比如视频、图文）的链接，也可以是客户其他自定义页面，详情请查看帮助中心文档。

响应参数

参数名称	类型	描述
code	int	状态码，0表示成功，其他错误码见全局返回码
msg	string	错误信息提示
data	array	数据
login_url	string	登录接口，有效期为1分钟
permission_denied_url	string	店铺无SDK权益包权限跳转链接

示例

请求示例

{
    'access_token':'xxxxxxxxxx',
    'user_id':'xxxxxxxxxx',
    'data' : {
        'login_type':1,
       'redirect_uri':'https://appQvk85iBI7258.h5.xiaoeknow.com'
    }
}

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "permission_denied_url": "",
        "login_url": "https://h5.xiaoe-tech.com/platform/login_cooperate/h5_login?token=4b5b24c1b25573a3d1553c6e937bc1b0&app_id=appxxx"
    }
}

帮助

用户没有登录态（展示）

用户有登陆态（展示）

先决条件#

本教程所涉及的接口都先要获得access_token#

用户注册#

用户登录（无登录态）#

配置跳转登录页#

获取登录鉴权链接#