开始使用 - 友好速搭 -- 开发文档

友好速搭

JS SDK
简介 开始使用 接口列表

开始使用

在需要调用 JS SDK 的页面<head>标签引入如下 JS 文件:

{{ 'jssdk-x.x.x.min.js' | global_asset_url | js_tag }}  // 请自行替换 x.x.x 为最新版本

版本更新信息:GitHub - https://github.com/yeezon/shop-jssdk/releases

验证引用

JS SDK 正确加载后,会在 window 对象下加入一个全局对象 yhsd

可以使用如下脚本验证是否正确引用:

<script>
    yhsd.version();  // 返回版本号即为加载成功
</script>

调用接口

<script>
    yhsd.ready(function(jssdk){
        jssdk.account.current(function(){
            // 检查当前登录账号
        });
    });
</script>

接口功能

全局对象yhsd下包含以下几类接口:

  1. 实用工具 - 常用方法的集合,包括设置获取 Cookie,设置获取 URL 参数等方法等;查看详情

  2. 数据接口 - 基于店铺 AJAX API 封装的接口,用于前端获取数据(如:查看购物车,商品列表,轻博客内容)和提交数据(如:用户注册,收货人信息维护,修改购物车等);查看详情
    注:JS SDK 中,与 Liquid 模板输出数据一致的对象,其文档将会跳转至 主题开发 -> 语法与对象 章节,方便对照查看并确保数据一致;

  3. 事件接口 - 基于订阅 / 发布模式封装的接口,用于开发者自定义流程,或者修改、重写原有接口(上一点提到的数据接口)逻辑。查看详情

显示调试信息

请在引用 JS SDK 前,声明全局变量yhsdDebug打开事件调试信息,如:

<script>
    window.yhsdDebug = true;  // 调试信息开关
</script>
{{ 'jssdk-x.x.x.min.js' | global_asset_url | js_tag }}  // 请自行替换 x.x.x 为最新版本

源码与历史版本

GitHub - https://github.com/yeezon/shop-jssdk

免费领取15天试用
立即注册
联系客服
微信咨询
微信二维码

领取免费试用资格

姓名 *

电话 *

公司名称

所在地区

意向产品

提交

提交成功

你好, XXX女士/先生 ,你的需求已提交成功,后续会有专门的客户经理与你电话联系。谢谢!