小鹅通 · 云服务 API
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
  1. 内嵌SDK服务场景
  • 开发前必读
    • 小鹅云介绍
    • 更新日志
    • 开始开发
    • 小鹅通开放API开发交流群
  • 开发指南
    • 创建并授权应用
    • 获取access_token(含代码示例)
    • 开通接口权限
    • 全局返回码
    • 常用工具
      • 日志排查工具
  • 场景方案
    • 同步用户场景
    • 同步商品场景
    • 同步订购关系场景
    • 同步积分场景
    • 同步页面统计场景
    • 同步学习数据场景
    • 同步推广员场景
  • 内嵌SDK服务场景
    • 产品简介
    • 小鹅通SDK开发者声明
    • 小鹅通SDK个人信息保护政策
    • 开发指南
    • Android-SDK 接入
    • iOS-SDK 接入
    • H5直接嵌入
    • SDK&H5账号详解
    • 常见问题
    • 原生SDK登录态
      • 先决条件
      • 登录接口
      • 登出接口
  • 消息推送
    • 使用说明
    • 消息加/解密
    • 消息接收URL校验说明
    • 账号合并推送
    • 用户手机号变更推送
    • 用户状态变更推送
    • 用户注册推送
    • 商品变更推送
    • 订单支付推送
    • 订单状态变更推送
    • 优惠券消息推送
    • 信息采集推送
    • 积分变更推送
    • 考试消息推送
    • 活动签到推送
  • API列表
    • 用户管理
      • 使用说明
      • 注册新用户
      • 更新用户信息
      • 获取用户列表2.0
      • 获取用户列表1.0.0
      • 查询单个用户信息
      • 批量查询获取用户信息
      • 获取用户消费信息
      • 获取课程学员列表
      • 查询单个用户标签列表
      • 查询用户合并记录
      • 获取标签列表
      • 添加/修改标签
      • 添加/修改用户标签
    • 学习数据管理
      • 获取学习记录列表
      • 获取每日学习记录
      • 获取指定资源学习记录信息
      • 获取营期下用户的学习情况
    • 直播管理
      • 获取直播列表
      • 获取班课列表接口
      • 获取签到列表
      • 获取签到学员列表
      • 获取直播红包列表
      • 获取红包领取记录
      • 获取直播数据概览
      • 获取直播详情
      • 获取红包数据概况
    • 商品管理
      • 查询商品列表2.0
      • 查询商品列表1.0
      • 拉取组合课的资源列表4.0
      • 拉取组合课的资源列表3.0
      • 获取训练营营期任务
      • 商品详情2.0
      • 商品详情1.0
      • 获取直播带货商品列表
      • 商品增加库存
      • 商品减少库存
      • 新建实物商品
      • 编辑实物商品
      • 删除实物商品
      • 获取实物商品列表
      • 获取C端搜索商品列表
    • 商品分组管理
      • 获取店铺商品分组列表
      • 获取商品分组内商品列表
      • 批量新建/更新商品分组
      • 删除商品分组
    • 素材管理
      • 获取素材列表
      • 获取素材分组列表
      • 素材分组编辑
      • 素材分组移动
      • 素材分组删除
    • 订单管理
      • 获取订单列表1.1
      • 获取订单列表1.0
      • 查询用户订单列表
      • 获取订单详情
    • 订购管理
      • 用户开通产品包权益
      • 查询用户订购资源列表
      • 用户购买关系查询
      • 查询用户资源权益2.0
      • 查询用户资源权益1.0
      • 取消订购
    • 物流管理
      • 普通实物单发货
    • 推广员管理
      • 查询推广员列表
      • 查询推广员客户列表
      • 查询推广员的下级推广员列表
      • 查询指定推广员的信息
      • 查询客户所属推广员
      • 新增推广员
      • 推广员绑定客户
      • 修改/解除绑定关系
      • 设置推广员上级
      • 推广订单详情
      • 按日期查询推广员的收益和新增加的下级
      • 推广订单详情(支持购物车订单返回多条记录)
    • 信息采集管理
      • 获取信息采集列表
      • 获取单个信息采集结果
      • 获取用户信息采集结果
      • 根据表单ID以及用户ID获取信息采集结果
    • 营销码卷管理
      • 优惠券列表
      • 获取优惠券详情2.0
      • 获取优惠券详情
      • 获取优惠券领券用户
      • 发放优惠券2.0
      • 发放优惠券
      • 优惠券核销
      • 获取优惠码列表
      • 获取优惠码码库列表
      • 获取优惠码效果数据
      • 创建优惠码
      • 优惠码添加库存
      • 优惠码失效
      • 编辑优惠码
      • 优惠码删除
      • 获取兑换码码库列表
      • 追加兑换码库存
      • 创建兑换码
      • 编辑兑换码
      • 兑换码失效
      • 用户使用兑换码
      • 获取兑换码批次列表
    • 积分管理
      • 业务类型说明
      • 查询用户积分日志
      • 获取单个用户积分信息
      • 批量获取用户积分列表
      • 获取店铺积分信息
      • 批量发放积分
      • 批量扣减积分
      • 解冻冻结积分
      • 设置店铺积分过期时间
    • 页面统计管理
      • 新建页面统计
      • 编辑页面统计
      • 获取页面统计列表
      • 获取页面统计详情
      • 获取页面统计订单列表
      • 新建投放渠道
      • 获取投放渠道列表
    • 打卡管理
      • 获取打卡列表
      • 获取打卡参与用户
      • 获取指定学员活动日记列表
      • 获取活动点赞列表
      • 获取指定学员被点赞总数和列表
      • 获取用户日记被点评/评论列表
    • 社群管理
      • 获取用户参与的小社群
    • 考试管理
      • 获取考试列表
      • 获取考试详情
      • 获取考试结果列表信息
      • 获取考试结果详细信息
    • 活动管理
      • 获取活动列表
      • 获取签到列表
      • 获取活动报名列表
      • 获取活动签到信息
    • 组织管理
      • 获取员工列表
      • 获取员工详细信息
      • 添加或者保存员工信息
      • 启用员工
      • 停用员工
      • 删除员工
      • 根据员工账号获取用户ID
      • 获取组织结构树
      • 添加或修改组织架构
      • 移除组织架构
    • 微页面管理
      • 获取微页面列表
    • 企学院专用
      • 学员管理
        • 企学院获取学员列表
        • 企学院添加学员
        • 企学院修改学员
        • 企学院删除学员
        • 企学院添加组织架构
        • 企学院删除组织架构
        • 企学院编辑组织架构
        • 企学院获取组织架构
        • 企学院获取部门信息
      • 活动管理
        • 企学院用户签到活动列表
      • 培训计划管理(限企学院)
        • 获取培训计划列表
        • 获取培训计划详情
        • 获取用户培训学习数据
        • 获取员工的培训计划列表
  • 旧版API
    • 使用须知
    • 旧版指南
      • 签名和请求
      • Xiaoe SDK使用简介
      • 状态码和常见问题
    • 用户
      • 用户注册
      • 用户信息修改
      • 获取用户信息
    • 支付
      • 下单
      • 更新订单状态
    • 订单
      • 订单查询1.0
      • 订单查询2.0
    • 订购
      • 订阅列表查询
      • 订阅用户列表查询
      • 取消订阅
  • 常见问题
    • 问题汇总
    • 问题反馈
  1. 内嵌SDK服务场景

H5直接嵌入

先决条件#

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

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

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

用户注册#

时序图 img 接口请求
接口文档详见注册新用户

用户登录(无登录态)#

时序图 img

配置跳转登录页#

为什么配置跳转登录页
1.
实现客户侧和小鹅侧的账号打通,小鹅通的获取登录链接接口需传递 user_id 参数,指定登录的具体用户。用户未登录时,跳转到配置的登录页,引导用户先在客户侧登录获取user_id,然后再调用小鹅的注册接口进行注册,获取小鹅侧的user_id,从而实现两端的账号数据关联
2.
客户可在配置的登录页实现自己个性化的登录逻辑。
3.
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) ,或者是具体的某个资源(比如视频、图文)的链接,也可以是客户其他自定义页面,详情请查看帮助中心文档。
响应参数
参数名称类型描述
codeint状态码,0表示成功,其他错误码见全局返回码
msgstring错误信息提示
dataarray数据
login_urlstring登录接口,有效期为1分钟
permission_denied_urlstring店铺无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"
    }
}

帮助#

用户没有登录态(展示) img
用户有登陆态(展示) img
上一页
iOS-SDK 接入
下一页
SDK&H5账号详解
Built with