加载中…

SDK 文档 apifm Developer

SDK

官网首页接口文档开源项目帮助中心案例展示联系我们后台管理

安装教程

版本更新

微信小程序安装

vue开发web或者h5应用

字节/头条/抖音小程序

Flutter安装

uni-app安装

内置方法

设置专属域名

修改商户ID

通用调用api地址

工具类接口

阿里云内容检测服务

html格式富文本内容转为纯文本

调用后台mock数据接口

查询IP归属地

长链接/短链接转换

查询条形码

获取唯一序列号

查询手机号码归属地信息

获取手机号段数据

上传文件（图片/视频）

省市区县数据

自动识别并提取行政区数据

关键词搜索行政区

通过ID读取详细信息

获取所有省份

获取下一级地理信息

获取所有的城市数据

获取所有的区县数据

获取所有的街道数据

数据隧道

临时数据存放

投票&问卷调查

读取投票项目列表（拉取问卷）

获取题目详情（列出所有可选项）

提交投票【单道题目】

提交投票【按分类】

我的投票记录【单个题目】

我的投票记录【题库分类】

我的投票详情

查看我邀请的人的投票记录

Json数据管理

获取Json数据列表

添加/修改Json记录

删除Json记录

置顶Json记录

设置Json记录高亮显示

时间日期

计算2个时间相差的毫秒数

读取服务器时间

获取未来几天的日期

获取二维码

排队取号

排队进度查询

取号

获取队列分类

分布式同步锁

加锁

释放锁

寄存

查看详情

我的寄存记录

地图相关

驾车线路规划

地址解析

逆地址解析

在给定的区域内根据关键词搜索地点

计算两个定位之间的距离(非直线)

计算两个定位之间的直线距离

通过经纬度查找地理位置

系统设置

读取系统参数（单个）

读取系统参数（批量）

积分模块

成长值

积分兑换成长值

成长值明细

积分即将到期统计

当前登录用户积分汇总

读取最新50条积分动态

用户积分按照日期排行榜

用户积分总排行榜

每日补足指定数量积分

读取积分赠送规则

每日签到送积分

读取连续签到赠送积分规则

判断今天是否已经签到

签到接口

读取历史签到记录

积分券兑换积分

用积分兑换可用余额

读取积分明细

做任务领积分

读取任务列表

标记某个任务为完成状态

CMS

文章分类

读取单页面数据

文章管理

文章发布人浏览量排行榜

修改扩展计数字段

发布文章

删除自己发布的文章

获取文章列表

读取文章详情

获取上一篇/下一篇

文章点赞/踩一下

收藏

检测是否可以收藏

收藏文章

获取收藏的文章列表

根据收藏记录ID删除收藏

根据文章ID删除收藏

留言接口

拉取留言/评论列表

删除自己的留言

获取标签云

活动签到

获取某个活动的签到用户列表

线上活动用户签到

线下活动管理员签到

检测某个活动是否签到

商城模块

品牌管理

品牌收藏

检测是否已收藏

删除品牌收藏

添加品牌收藏

品牌收藏列表

获取商品交易动态

商品管理

商品缺货登记

抢占秒杀名额

商品分类

商品列表

商品详情

商品详情

商品的可选配件

读取限购设置

拉取评价数据

获取商品价格

获取商品分级定价信息

获取商品的会员价/折扣

获取某个SKU价格和库存

获取商品按天定价和库存

商品点赞/点踩

浏览足迹/历史/购买过的商品

获取购买过的商品列表

删除商品历史购买记录

商品浏览历史记录/足迹

商品收藏

检测是否已收藏某个商品

加入收藏

获取收藏的商品列表

删除收藏记录

每日销售汇总

用户发布商品

我发布的商品列表

删除自己发布的商品

时段定价

获取商品时段定价日历数据

获取商品时段定价的所有日期

获取商品某天的所有时段信息

产品购买排行榜

视频剧集

获取指定商品的剧集列表

购买某一集

购物车

标记购物车记录选中状态

清空购物车

读取购物车数据

加入购物车

修改购物车商品数量

删除购物车记录

营销工具

商城活动

商城活动详情

抽奖

读取我的抽奖信息

参与抽奖

获取抽奖项目详情

参与抽奖记录

砍价

读取商品的砍价设置

发起砍价

删除砍价记录

读取我发起的砍价详情

读取砍价进程

帮助好友砍一刀

获取帮砍记录

优惠券

核销优惠券

获取所有可领券

查看优惠券详情

领取优惠券

我的优惠券

合并优惠券

赠送优惠券给别人

动态口令兑换优惠券

分享优惠券让别人抢

获取优惠券分享密钥

取消优惠券分享密钥

通过分享密钥领取优惠券

分销

三级分销

直接升级成为分销商

分销商业务统计

重新绑定分销商（抢客）

获取年销售额统计

获取每日（月）佣金和销售额汇总记录

读取后台分销商设置

申请成为分销商

查看申请审核进度

购买分销商资格

我的团队成员

获取佣金记录

我的佣金统计

待结算佣金统计

分销商累计销售额排行榜

分销商团队累计销售额排行榜

分销商某天的销售额排行榜

获取分销专用商品

获取团队月报表

市区合伙人信息

市区合伙人月报表

合伙人/团队长/团队成员三级分销

合伙人名下用户的提现驳回

合伙人名下用户的提现设为成功

合伙人查看名下用户的提现列表

获取成员列表

名下团队情况

购买成为合伙人

购买成为团队长

绑定团队长

读取后台合伙人分销设置

绑定合伙人

拼团

读取商品的拼团设置

获取指定商品的默认拼团设置

获取分级团购价格

发起一个拼单

获取拼团信息

获取当前所有进行中的团购列表

获取某个团的成员列表

获取我参与的所有团列表

商家/门店

门店区域信息

门店区域可选的所有城市

门店区域列表

门店区域详情

门店信息

获取门店/商家评价列表

门店/商家分类

获取取货点列表

获取我的门店信息

门店申请入驻

获取所有可选门店的城市列表

读取商家/门店列表

读取门店详情

收藏

订单管理

我的订单数据统计

读取后台订单设置

订单列表接口

订单详情接口

创建订单/下单

用余额支付订单

订单核销

确认收货

评价

修改评价

我的评价列表[针对商品]

删除评价

订单评价（好评、中评、差评）

关闭或者取消订单

删除订单

周期性订阅

停止周期性订阅

开始周期性订阅,针对已经停止的订阅重新开启

配送相关

快跑者

读取快跑者订单进程

读取快跑者配送员定位

闪送

获取闪送测订单详情

获取闪送骑手信息

美团配送

查看订单美团配送定位

商家自己配送

配送员业绩统计

获取后台设置配送费列表

配送管理员获取所有配送员列表

配送员读取自己的配送资料

修改接单状态

可抢单订单列表

配送订单列表

配送订单详情

配送员抢单

管理员手动派单

设置预计完成时间

标记为开始配送

标记为配送完成

修改配送完成的备注

售后

填写寄回包裹信息

申请售后

获取订单的售后详情

取消售后

获取订单退款记录

知识付费

我的购买记录

购买虚拟物品

虚拟物品详情

虚拟物品列表

扫码点餐

扫码点餐结账接口

桌号列表

桌号详情

扫码点餐下单

根据桌码ID和密钥获取桌子Token和uid

商品橱窗

查看用户橱窗信息

修改橱窗信息

橱窗商品列表

将商品加入橱窗

将商品从橱窗中移除

判断商品是否在橱窗中

社区团购

通知用户到自提点取货

支付团长招募费用

申请社团团长信息

申请成为社团团长

获取社区团购设置信息

接龙

读取接龙的参与列表

将商品从接龙移除

将商品添加到接龙，用户可以选购

删除接龙记录，取消以后的接龙才可以删除

接龙成团，并截止用户继续参与

取消接龙，所有的已支付的订单退款处理

接龙详情

添加/修改接龙

我发起的接龙列表

读取接龙设置

小程序开发

支付宝小程序

绑定手机号

微信小程序

商家转账用户确认模式下，在微信客户端通过小程序拉起页面请求用户确认收款

当前登录用户绑定微信小程序openid/unionId

订阅消息及次数管理

转发微信群赠送用户积分

获取微信小程序码

获取微信绑定的手机号码

QQ小程序

获取小程序码

字节小程序

获取小程序码

站点运营

通过微信小程序appid获取专属域名

联系客服列表

获取站点信息

系统公告

读取广告位

Banner轮播图

友情链接/合作伙伴

读取当前站点的会员类型

登录&注册&授权

读取当前所有登录的设备列表

检测token是否有效

检测邀请人是否有效

支付宝小程序授权获取用户token

微信小程序授权获取用户token

QQ小程序授权获取用户token

字节小程序授权获取用户token

登录接口

邮箱登录

微信小程序登录

微信小程序手机号码一键登录

字节小程序登录

QQ小程序登录

用户名密码登录

手机号密码登录

短信验证码登录

注册接口

用邮箱注册用户

微信小程序用户简易注册

微信小程序用户详细注册

QQ小程序用户详细注册

头条小程序用户注册

通过用户名注册用户

通过手机号验证码注册用户

一键授权（登录&注册）

微信公众号网页授权登录

退出登录

用户&会员&社交

盲盒交友

获取盲盒设置

获取我的匹配和投放余额

解锁盲盒

获取充值解锁次数赠送规则

投放记录

解锁记录

删除我投放的数据

修改投放状态

购买解锁次数

待支付的盲盒进行支付

投放盲盒

匹配获取5个盲盒

获取任意用户的信息

随机获取昵称/网名

读取用户来访动态

绑定业务员

用户详情

获取用户详情

获取支付宝小程序的用户ID和accesstoken

获取微信openid和unionid

获取用户动态会员码

获取我邀请注册的用户信息

编辑资料

用户修改资料

找回密码

短信验证码重置密码

邮箱验证码重置密码

短信验证码绑定手机号

字节小程序绑定手机号

微信小程序绑定手机号

设置登录用户名

修改登录密码

绑定邮箱地址【可用来登录】

好友

添加好友

读取好友列表

删除好友

查看好友资料

IM聊天&留言

拉取和好友的聊天记录

给好友发送消息

清空聊天记录

朋友圈&动态

发布朋友圈

拉取朋友圈时间线

查看朋友圈记录详情

删除朋友圈记录

删除朋友圈的某条评论

朋友圈点赞

朋友圈评论

朋友圈动态

漂流瓶

仍瓶子

捡瓶子

收货地址管理

添加收货地址

修改收货地址

读取收货地址列表

获取收货地址详情

获取默认收货地址

删除收货地址

会员等级

获取后台设置的所有会员等级

获取会员等级详情

获取会员收费项目

购买会员等级

获取我的购买记录

绑定银行卡

读取绑定的银行卡信息

读取可选的银行列表

绑定银行卡

解绑

绑定开票信息

读取用户绑定的开票信息

绑定

解绑

实名认证【人工审核】

实名认证【自动审核】

注销（删除）用户

用户消息&站内信

删除消息&站内信

设为已读

用户消息&站内信列表

用户标签认证

用户标签认证

查询用户标签认证状态

用户标签列表

第三方集成

京东VOP

调用前必读

获取商品列表

获取VOP商品详情

获取商品轮播图片

检测是否可购买

购物车

获取购物车数据

加入购物车

修改购物车某商品数量

选中/取消选择某条记录

移除某条记录

清空购物车

在线支付

stripe

直连扣款

删除绑定的银行卡

绑定的银行卡列表

绑定银行卡

收银台支付

翼支付

翼支付唤起H5收银台

翼支付下单接口

读取充值赠送规则

发起支付通用方法

支付状态查询

微信支付

微信小程序支付

微信h5网页支付

微信公众号支付

用户主动扫微信二维码支付

商家扫用户的微信付款码完成支付

APP支付（Android、ios）

字节小程序支付

CCPAY & VVPAY小程序支付

Fomo支付

Paypal支付

支付宝

获取免签付款码

支付宝小程序支付

支付宝电脑网页端支付

支付宝h5端支付

APP支付（Android、ios）

用户主动扫描二维码完成付款

商家扫描用户的支付宝付款码完成支付

汇率查询接口

验证码

图形验证码

短信验证码

邮件验证码

财务管理&资金相关

交易密码 & 支付密码

重置交易密码

修改交易密码

首次设置交易密码

获取用户可用余额、积分等资产

读取资金明细列表

用户收入支出统计

获取充值/支付记录

发票业务

查看我申请的所有发票

查看发票详情

申请发票

提现

读取后台提现设置

提现记录

提现记录详情

申请提现

获取满减规则

线下买单

押金功能

用户主动支付押金

获取我的押金记录列表

押金记录详情

申请退押金

会员卡

赠送好友

通过秘钥领取会员卡

取消分享

获取分享秘钥

用口令领取会员卡

获取可购买会员卡列表

查看会员卡详情

购买会员卡

获取我的会员卡

我的会员卡消费明细

流媒体&音视频

获取阿里云点播服务上传凭证

根据视频编号获取视频信息

微信小程序直播

获取直播间列表

获取直播间的历史回放

实时音视频

TRTC获取userSig等信息

活动 & 预约

收藏

预约报名收藏列表

删除预约报名收藏

添加预约报名收藏

检测是否已收藏

报名团队

预约/报名项目的所有团队列表

预约/报名项目的团队长删除某个成员

预约/报名项目的团队详情

预约/报名项目获取团队成员列表

预约项目点赞

CP匹配活动

设置个人资料

cp匹配活动详情

投票活动

报名记录详情

投票活动领取票数

投票活动积分兑换投票数规则

投票活动-我的票数余额

投票活动-进行投票

报名参加投票活动

投票活动获取参与列表

投票活动详情

投票活动列表

跑腿 & 任务

发布人确认验收

接单后点击完成

接单

支付任务赏金

发布任务

用户发布活动 / 预约

用户删除自己发布的预约项目

预约/报名项目列表

预约项目详情

预约 / 报名

支付报名费

我的

用户自己完成预约

修改预约/报名信息

删除报名记录

查看详情

我的预约/报名记录

服务员&技师

获取服务员/技师列表

获取服务员/技师详情

技师可提供的服务（商品）

技师设置可提供的服务

获取某个服务的技师排班信息

查询技师设置的某天可预约的时间段

技师设置可预约的时间段

技师绑定商家 / 解绑

技师修改工作状态

技师评价列表

技师的工装照列表

技师删除工装照

技师添加工装照片

修改技师个人信息【申请成为技师】

技师收藏

收藏技师

检测某个技师是否已收藏

获取收藏的技师列表

删除收藏的技师

订单操作

技师订单统计

技师接单

拒绝接单

设置订单为已服务 / 交易完成

设置订单为服务中/开始服务

团队/组织/协同办公/共享网盘

网盘

删除网盘文件

修改网盘文件信息

获取网盘文件列表

网盘文件下载

网盘上传文件

公告

删除组织公告

组织公告添加/修改

获取组织公告详情

获取组织公告列表

获取组织收费列表

创建组织

升级组织规模

修改组织资料

邀请成员加入组织

设置（取消）某人为管理员

成员离开组织

设置自己在组织内的昵称

解散组织（删除组织）

获取组织列表

查看组织详情

获取成员列表

共享表格/共享字段/共享文档

初始化表格数据

获取共享表格的所有单元格

设置单元格内容

轮训读取单元格修改动态

微信公众号开发

当前登录用户绑定openid

获取JS-SDK使用权限签名

推广运营

发圈素材

发圈素材详情

发圈素材列表

获取发圈素材分类

CPS

淘宝客

淘宝联盟获取短链

淘宝联盟获取淘口令

淘宝联盟商品详情

拼多多

拼多多联盟订单详情

拼多多联盟订单列表

拼多多联盟获取短链

拼多多联盟商品详情

拼多多推广位及用户备案

京东联盟

京东联盟商品转链

京东联盟商品搜索

京东商品设置优惠券信息

京东商品查询上一次设置的优惠券信息

京东联盟商品详情

京东联盟类目

IoT物联网

获取指定订单对应的Iot设备列表

获取指定订单对应的设备支持的控制指令列表

执行设备远程指令

AI

AI写作

客户定制

MTJ

分红记录

读取MTJ转账记录明细

转账MTJ给其他用户

读取后台MTJ设置

读取自己的MTJ资金流水

读取自己的MTJ资产

获取当前站点总共MJT发放情况

收藏卡片

卡片收藏记录详情

卡片收藏记录

通过卡号查看卡片详情

解除绑定收藏卡

绑定收藏卡

课程销售

用余额支付课程购买订单

获取我的的报名记录

报名记录

购买课程订单详情

删除课程购买订单

关闭课程购买订单

购买课程

课程详情

课程列表

培训模块

老师功能

老师查看学员列表

老师查看学员的签到记录

老师进行员工宿舍添加/编辑

老师或家长查看员工宿舍列表

老师查看员工宿舍详情

老师删除员工宿舍

老师进行每日饮食添加/编辑

老师查看每日饮食列表

老师查看每日饮食详情

老师删除某日饮食

老师日常管理内容添加

老师日常管理列表

老师删除日常管理记录

家长功能

学员查看家长列表

家长通过邀请码秘钥和学员绑定关系

学员获取邀请家长的秘钥,5分钟有效

家长查看学员的签到记录

家长查看学员列表

读取我的家长身份信息

教练功能

教练列表

训练计划完成设置成绩

教练给学员设置训练计划

教练给学员删除训练计划

给学员添加入学考核成绩

教练给学员填写阶段性考核成绩

教练给学员填写对抗记录

教练给学员填写比赛记录

考勤列表

考勤签到或者签退

查看学员比赛记录

查看学员对抗记录

查看学员阶段性考核成绩

获取所有的训练项目

训练项目分类

查看学员的入学考核成绩

查看学员训练计划

学员详情

查看学员列表

教练评价列表

赛事模块

裁判设置对阵桌号

裁判回填场次比赛成绩

获取赛程对阵图表数据

参赛选手抽签获得抽签号码

赛事赛程报名

赛事赛程报名列表

我报名的赛程列表

赛事赛程详情

赛事赛程列表

赛事信息详情

赛事列表

游戏

数字炸弹王

数字炸弹王-游戏记录

数字炸弹王-猜炸弹位置

数字炸弹王-开始新一轮游戏

图片交易

图片购买记录明细

图片购买记录

使用余额支付购买图片的记录

购买图片

图片交易所有图片库列表

删除网盘文件

删除网盘文件

SDK 文档 apifm 开发参考

```javascript WXAPI.organizePanDelete({ token: '000' }) ``` + token 当前用户登录凭证 + fileId 文件ID