小鹅通 · 云服务 API
首页
解决方案
开放API
APP开店
文档中心
应用市场
控制台
首页
解决方案
开放API
APP开店
文档中心
应用市场
控制台
登 录
注 册
内嵌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
订购
订阅列表查询
订阅用户列表查询
取消订阅
常见问题
问题汇总
问题反馈
内嵌SDK服务场景
复制页面
产品简介
一.产品简介
#
1.1产品概述
#
为满足商家通过移动应用搭建自有知识店铺、打通全渠道店铺的业务诉求,将小鹅通的内容交付系统以SDK及H5嵌入形式开放出来,赋予开发者应用丰富的内容交付和变现的功能。
小鹅通 App内嵌SDK服务目前提供的是 H5 版 SDK,将小鹅通提供的 HTML5 页面嵌入到终端,基于此提供账号打通、内容分销、支付营销、直播课程能力开放等 App 应用特色功能,更拥有媲美原生页面的性能。该方案接入极速、功能完善、性能稳定。
1.1.1方案优势
#
1. 账号打通
用户无需二次登录即可进入店铺浏览, 微信端、App端等多渠道数据打通,给用户提供一体化体验;用户信息、学习数据等留存在店铺管理台,可通过API接口同步到商家自研平台。
2. 多端搭建
商家在自有APP,PC官网,H5中可嵌入SDK,搭建自有知识店铺,做到真正的私域。
3. 功能全覆盖
小鹅通功能全覆盖+同步更新,包括直播,视频播放等。灵活适配多种行业,持续为商家赋能。
1.1.2功能列表
#
1.2试用/接入流程
#
👉确定接入方式:原生开发的APP接入原生APP,混合开发APP(Flutter,React Native,Uni-app 框架)和Web,接入WebSDK。
1.2.1接入原生SDK
#
接入要求:原生开发APP
进入管理台申请试用:
点击进入
SDK相关参数名词解释:
1.2.2接入WebSDK
#
接入要求:原生开发APP/混合开发APP/H5/PC
①是否需要测试店铺SDK包权限?(现有店铺已有用户数据则建议申请,避免影响现有用户使用)
②是则需要向客户经理/管家申请测试店铺SDK包权限:在管理台点击创建知识店铺,创建后,将APPID给到管家,管家会帮您申请测试店铺SDK包权限
③申请完成后,进入到测试店铺管理台,进入经营渠道-SDK服务,点击试用,填写相应信息(具体可见接入原生SDK指南)
点击进入
④开发完成后,向客户经理/管家申请配置登录页(webSDK需要将登录页交给客 户自定义)
点击进入
1.3客户接入案例
#
1.3.1金融行业
#
案例名称:广发基金●财富学院
案例介绍
广发基金管理有限公司成立于2003年,作为中国证监会批准成立的专业资产管理机构,是全国十大公募基金公司之一。广发基金APP是综合基金投资、陪伴服务的智能理财客户端。
使用SDK场景
1、通过直播联接投资者与投研团队,投研观点直达客户;
2、打造音视频、图文课程引流获客,投教内容高效触达;
页面展示
1.3.2案例名称:家慧库
案例介绍
家庭教育咨询知识服务,主要售卖直播,录播课程。
使用SDK场景
通过接入小鹅通直播功能,给课程产品进行预热,引流,转化等。
页面展示
二.常见问题
#
1.SDK是否支持自定义页面UI?
主页面(如列表页)可以通过小鹅通管理台配置微页面自定义页面展示。直播、课程详情页面无法配置。
您也可以自主开发页面,仅嵌入小鹅通的课程详情页。
2.小鹅通的B端管理台是否可以通过SDK嵌入到自研的管理台?
不支持。小鹅通SDK是将知识店铺H5链接嵌入到您的APP或Web中,管理台暂不支持嵌入。
3.SDK是否支持二次开发?
暂时不支持二次开发,您可以选择只接入小鹅通的课程页面,其他页面自主开发。
4.SDK不支持什么功能
SDK支持99%现有知识店铺功能,如直播,音频视频播放等。但暂不支持所有基于微信生态的功能,如直播间红包,模板消息推送等。具体您可以看功能列表。
5.原生SDK和WebSDK有什么区别
接入差异:AppSDK只能接入到原生开发的APP中,WebSDK可以接入到原生开发和混合开发的APP以及Web中。
功能差异:原生SDK能调用原生APP的能力, 所以可以支持APP原生自有的功能,如点击放大查看图片。但WebSDK无法调用原生APP的能力,则无法支持。
6.SDK里可以用推广员吗?
支持,其中涉及较多技术方案,具体可以联系管家,邀请技术同事沟通具体反感。
上一页
同步推广员场景
下一页
小鹅通SDK开发者声明