加载中…

⚡ SDK 开发文档

只需前端技能,无需购买服务器,通过 SDK 与中台数据交互,即可独立开发微信小程序、H5、App、鸿蒙应用等全端产品。

微信小程序 抖音小程序 H5 / Web uni-app Flutter 纯 HTML

    SDK 使用说明

    选择你的开发平台,直接查看具体用法。

    第 0 步:获取你的专属域名和商户 ID

    下面所有示例中的 你的subDomain 和 你的商户ID,都在后台里查看,复制过来替换即可。

    1. 登录 管理后台
    2. 在左侧菜单点击 工厂设置 → 商户信息
    3. 页面里可以看到 商户ID 和 专属域名,直接复制使用

    提示:专属域名默认是 32 位长度,你可以自己修改成一个比较短、好记的域名再使用。修改后,代码里也要同步替换。

    微信小程序 使用教程

    apifm-wxapi · v26.11.20
    1. 1

      增加 npm 支持

      小程序项目根目录需存在 package.json,没有的话先执行下面的命令,确认生成后再继续。

      bash
      npm init
    2. 2

      安装 SDK

      一键安装 SDK 最新版本。

      bash
      npm install apifm-wxapi
    3. 3

      构建 npm

      在微信开发者工具中点击「工具 → 构建 npm」,提示构建成功后才能使用。

    4. 4

      初始化并调用

      init() 与 setMerchantId() 在 app.js 中全局执行一次即可,之后就能调用任意 SDK 方法读写后台数据。

      javascript
      // app.js
      const WXAPI = require('apifm-wxapi')
      WXAPI.init('你的subDomain')
      WXAPI.setMerchantId(你的商户ID)
      
      // 任意页面
      const res = await WXAPI.banners()
      if (res.code == 0) {
        this.setData({ banners: res.data })
      }

    开源参考:wechat-app-mall(GitHub) · 码云镜像

    Vue / H5 使用教程

    apifm-webapi · v26.11.20
    1. 1

      安装 SDK

      一键安装 SDK 最新版本。

      bash
      npm install apifm-webapi
    2. 2

      全局初始化

      在 main.js 中设置专属域名与商户 ID,并挂载到 Vue 原型上。

      javascript
      import WEBAPI from 'apifm-webapi'
      WEBAPI.init('你的subDomain')
      WEBAPI.setMerchantId(你的商户ID)
      Vue.prototype.$wxapi = WEBAPI
    3. 3

      调用方式一:无需引入

      在组件内通过 this.$wxapi 直接调用。

      javascript
      const res = await this.$wxapi.banners()
      if (res.code == 0) {
        this.banners = res.data
      }
    4. 4

      调用方式二:按需引入

      在 js 文件中直接加载 SDK,因已全局初始化,无需再次 init。

      javascript
      const WXAPI = require('apifm-webapi')
      const res = await WXAPI.banners()

    开源参考:vueMinishop(GitHub) · 码云镜像

    抖音小程序 使用教程

    apifm-ttapi · v26.11.20
    1. 1

      确认版本

      npm 能力要求基础库不低于 2.12.0,开发者工具 3.1.1 及以上。

    2. 2

      增加 npm 支持

      项目根目录需存在 package.json,没有的话先执行:

      bash
      npm init
    3. 3

      安装并构建

      安装后在开发者工具中执行构建,提示成功后才能使用。

      bash
      npm install apifm-ttapi
    4. 4

      初始化并调用

      init() 与 setMerchantId() 在 app.js 中全局执行一次即可。

      javascript
      const WXAPI = require('apifm-ttapi')
      WXAPI.init('你的subDomain')
      WXAPI.setMerchantId(你的商户ID)
      
      const res = await WXAPI.banners()
      if (res.code == 0) {
        this.setData({ banners: res.data })
      }

    Flutter 使用教程

    apifm · v26.11.20
    1. 1

      增加依赖

      在 pubspec.yaml 中加入依赖。

      yaml
      dependencies:
        apifm: ^0.0.5
    2. 2

      安装 SDK

      运行命令拉取依赖。

      bash
      flutter pub get
    3. 3

      初始化并调用

      导入后先设置专属域名和商户 ID,再调用任意 SDK 方法。

      javascript
      import 'package:apifm/apifm.dart' as WXAPI;
      
      WXAPI.init('你的subDomain');
      WXAPI.setMerchantId(你的商户ID);
      final res = await WXAPI.banners();

    uni-app 使用教程

    apifm-uniapp · v26.11.20
    1. 1

      安装 SDK

      一键安装 SDK 最新版本。

      bash
      npm install apifm-uniapp
    2. 2

      全局初始化

      在 main.js 中设置专属域名与商户 ID 并挂载。

      javascript
      import WXAPI from 'apifm-uniapp'
      WXAPI.init('你的subDomain')
      WXAPI.setMerchantId(你的商户ID)
      Vue.prototype.$wxapi = WXAPI
    3. 3

      调用方式一:无需引入

      直接通过 this.$wxapi 调用。

      javascript
      const res = await this.$wxapi.banners()
      if (res.code == 0) {
        this.banners = res.data
      }
    4. 4

      调用方式二:按需引入

      已全局初始化,无需再次 init。

      javascript
      const WXAPI = require('apifm-uniapp')
      const res = await WXAPI.banners()

    纯 HTML 使用教程

    apifm.min.js
    1. 1

      引入 js 文件

      在页面中用 <script> 直接引入下面的完整地址,无需下载、无需打包。每个页面只引入一个,之后即可使用全局变量 APIFM。

      xml
      <script src="https://www.apifm.com/apifm.min.js"></script>
    2. 2

      初始化

      在调用任何接口之前执行一次:先设置专属域名(subDomain),再设置商户 ID。两者都在后台「工厂设置 → 商户信息」中查看,见上方说明。

      javascript
      APIFM.init('你的subDomain')
    3. 3

      调用方法

      所有方法以 APIFM.方法名(参数) 调用,返回 Promise,数据结构为 { code, data, msg },code == 0 表示成功。

      javascript
      // 写法一:then
      APIFM.banners().then(res => {
        if (res.code == 0) console.log(res.data)
        else console.error(res.msg)
      })
      
      // 写法二:async / await
      const res = await APIFM.banners()
    4. 4

      常见问题

      提示 APIFM is not defined 说明 script 路径不对或代码写在了引入之前;不要用 file:// 直接打开页面,建议用本地服务器;跨域报错请在后台确认域名访问设置。