B2主题开发必备！REST API接口文档

基础信息
命名空间: b2/v1
认证方式: JWT Token (内置JWT认证)
请求方法: 主要为POST，部分为GET
基础URL: /wp-json/b2/v1/{接口名称}
用户登录与注册
核心接口

接口名称 请求方法 功能描述 参数说明
/loginOut POST 用户登出 无需参数
/regeister POST 用户注册 username, password, email, code
/socialLogin POST 社交登录 type, code, state
/sendCode POST 发送验证码 type, account
/forgotPass POST 找回密码 type, account, code
/resetPass POST 重设密码 password, repassword
/getRecaptcha POST 获取图形验证码 无需参数
/imgCodeCheck POST 验证码检查 code
微信相关
接口名称 请求方法 功能描述 参数说明
/getLoginQrcode POST 获取公众号二维码 无需参数
/mpLogin POST 关注并登录 code
/mpLoginInv POST 关注并使用邀请码登录 code, invitation_code
/getOauthLink GET 获取社交登录连接 type
绑定与邀请
接口名称 请求方法 功能描述 参数说明
/bindUserLogin POST 绑定用户登录 type, code
/invitationCheck POST 邀请码检查 invitation_code
/invRegeister POST 社交登录检查邀请码 type, code, invitation_code
/rebuildOauth GET 重新绑定社交账户 type
/unBuild POST 解除绑定社交账户 type
用户信息管理
个人信息
接口名称 请求方法 功能描述 参数说明
/getUserInfo POST 获取当前用户信息 无需参数
/saveNickName POST 保存昵称 nickname
/saveAvatar POST 保存头像 avatar
/saveCover POST 保存封面图 cover
/saveUrl POST 保存网址 url
/saveDesc POST 保存个人描述 desc
/saveSex POST 保存性别 sex
/saveUsername POST 保存用户名 username
/editPass POST 后台修改密码 old_pass, new_pass
收货地址
接口名称 请求方法 功能描述 参数说明
/getAddresses POST 获取收货地址 无需参数
/saveAddress POST 保存收货地址 name, phone, address等
/saveDefaultAddress POST 保存默认收货地址 id
/deleteAddress POST 删除收货地址 id
社交关系
接口名称 请求方法 功能描述 参数说明
/getAuthorInfo POST 获取用户页面的用户信息 author_id
/getAuthorFollowing POST 获取关注列表 author_id, paged
/getAuthorFollowers POST 获取粉丝列表 author_id, paged
/AuthorFollow POST 关注/取消关注 author_id, type
/checkFollowing POST 检查用户是否关注某人 author_id
/checkFollowByids POST 检查多个ID是否关注 ids
收藏与签到
接口名称 请求方法 功能描述 参数说明
/userFavorites POST 用户收藏与取消收藏 post_id, type
/getUserFavoritesList POST 用户收藏列表 paged, posts_per_page
/userMission POST 用户签到 无需参数
/getUserMission POST 获取签到数据 无需参数
/getMissionList POST 获取签到列表 paged
其他功能
接口名称 请求方法 功能描述 参数说明
/changeAvatar POST 用户头像选择 avatar
/saveQrcode POST 储存用户的QRcode qrcode
/getUserInvList POST 获取用户的邀请码列表 paged
/getUserPublicData POST 获取用户的公开信息 user_id
/searchUsers POST 搜索用户 s
/getUserWidget POST 小工具用户面板 无需参数
私信系统
接口名称 请求方法 功能描述 参数说明
/sendDirectmessage POST 给用户发私信 to_user, content
/getUserDirectmessageList POST 获取私信列表 paged, posts_per_page
/getMyDirectmessageList POST 获取私信对话 user_id, paged
/getNewDmsg POST 获取新的私信数量 无需参数
财务与积分
接口名称 请求方法 功能描述 参数说明
/getUserGoldData POST 获取财富页面信息 无需参数
/getGoldList POST 获取财富页面积分、余额记录 type, paged
/getUserMessage POST 获取用户消息 paged
/getGoldTop POST 获取财富排行信息 type
/cashOut POST 提现申请 amount, account
/getVipInfo POST 获取VIP信息 无需参数
/cardPay POST 卡密充值 card_number, card_password
文章内容管理
文章列表
接口名称 请求方法 功能描述 参数说明
/getPostList POST 获取文章模块内容 paged, posts_per_page, category
/getModulePostList POST 获取模块文章列表 module, paged
/getAnnouncements POST 获取公告列表 paged
多媒体内容
接口名称 请求方法 功能描述 参数说明
/getPostVideos POST 获取视频播放列表 post_id
/getPostAudio POST 获取语音播放字符串 post_id
/getVideoHtml POST 获取外链视频的html url
/getDogeVideo POST 获取dogevideo视频 post_id
文章操作
接口名称 请求方法 功能描述 参数说明
/getPostData POST 获取文章相关信息 post_id
/postVote POST 文章顶踩 post_id, type
/getPostVote POST 获取文章顶踩数据 post_id
/getHiddenContent POST 获取隐藏段代码内容 post_id, type
/checkUserWriteRole GET 检查投稿权限 无需参数
/previewPost POST 预览文章 title, content等
/insertPost POST 投稿 title, content, category等
/deleteDraftPost POST 删除文章 post_id
/checkWriteUser POST 检查文章编辑权限 post_id
下载功能
接口名称 请求方法 功能描述 参数说明
/getDownloadData POST 获取文章下载数据 post_id
/getDownloadPageData POST 获取下载跳转页面数据 post_id
/downloadFile POST 获取下载文件的真实地址 post_id, file_id
评论系统
接口名称 请求方法 功能描述 参数说明
/getCommentList POST 获取评论 post_id, paged
/getCommentTips GET 获取评论tips 无需参数
/commentVote POST 给评论赞踩 comment_id, type
/commentVoteData POST 获取评论踩赞数据 comment_ids
/getUserRole POST 获取用户的权限 无需参数
/commentSticky POST 置顶评论 comment_id, type
/commentSubmit POST 发布评论 post_id, content等
/getNewComments POST 获取最新评论 paged
商城功能
商品管理
接口名称 请求方法 功能描述 参数说明
/getShopItemsData POST 通过ID获取商品信息 post_id
/getShopList POST 获取商品分类 category
/ShopCouponReceive POST 领取优惠券 coupon_id
/getMyCoupons GET 获取我的优惠券 无需参数
/deleteMyCoupon POST 删除我的优惠券 coupon_id
/getCouponsByPostId POST 获取商品优惠券信息 post_id
购物车
接口名称 请求方法 功能描述 参数说明
/getMyCarts GET 获取购物车 无需参数
/getMyCarts2 POST 获取购物车 无需参数
/setMyCarts POST 设置购物车 post_id, count
/deleteMyCarts POST 删除购物车商品 post_id
订单管理
接口名称 请求方法 功能描述 参数说明
/getMyOrders POST 获取用户的订单 status, paged
/getOrderInfo POST 获取单个订单信息 order_id
/userChangeOrderState POST 确认收货 order_id
/getUserBuyResout POST 获取购买结果信息 post_id
/getOrderExpress POST 快递查询 order_id
支付系统
接口名称 请求方法 功能描述 参数说明
/checkPayType POST 检查支付方式 amount
/BatchPayment POST 批量支付 orders
/allowPayType POST 获取允许的支付 无需参数
/buildOrder POST 开始支付 post_id, count, pay_type等
/balancePay POST 余额支付 order_id
/creditPay POST 积分支付 order_id
/payCheck POST 支付确认 order_id
圈子社区系统
圈子管理
接口名称 请求方法 功能描述 参数说明
/getCirclesList POST 获取圈子列表 paged, category
/createCircle POST 创建圈子 name, desc, avatar等
/joinCircle POST 加入圈子 circle_id
/getCircleUserList POST 获取圈子用户 circle_id, role, paged
/changeUserRole POST 审核会员 circle_id, user_id, role
/removeUserFormCircle POST 删除圈友 circle_id, user_id
话题管理
接口名称 请求方法 功能描述 参数说明
/getTopicList POST 获取话题列表 circle_id, paged, type
/insertCircleTopic POST 发布话题 circle_id, title, content等
/setSticky POST 话题置顶 topic_id, type
/setBest POST 话题加精 topic_id, type
/deleteTopic POST 删除话题 topic_id
/topicChangeStatus POST 话题审核 topic_id, status
问答系统
接口名称 请求方法 功能描述 参数说明
/submitAnswer POST 提交答案 topic_id, content
/getAnswerData POST 获取答案数据 topic_id, paged
/setAnswerRight POST 采纳答案 answer_id
/answerRight POST 采纳答案 answer_id
/deleteAnswer POST 删除答案 answer_id
其他功能
接口名称 请求方法 功能描述 参数说明
/getTopicCommentList POST 获取话题评论列表 topic_id, paged
/insertTopicCard POST 插入话题卡片 topic_id, content
/getCurrentUserCircleData POST 获取当前用户圈子数据 无需参数
/getChildComments POST 获取子评论 parent_id, paged
/getAllCircleData POST 获取所有圈子数据 paged
/getDataByTopicId POST 通过ID获取帖子内容 topic_id
/getCircleDataByCircleIds POST 通过ID获取圈子数据 circle_ids
/topicVote POST 话题投票 topic_id, type
/topicGuess POST 话题猜测 topic_id, guess
/getEditData POST 获取编辑数据 topic_id
/getCircleTopCats POST 获取圈子顶级分类 无需参数
文件上传
接口名称 请求方法 功能描述 参数说明
/fileUpload POST 图片上传 file, type
其他功能
链接管理
接口名称 请求方法 功能描述 参数说明
/submitLink POST 提交链接 name, url, desc等
/linkHasPending GET 检查是否有待审核链接 无需参数
/getLinkVote POST 获取链接投票 link_id
/linkVote POST 链接投票 link_id, type
资讯系统
接口名称 请求方法 功能描述 参数说明
/getInfomationList POST 获取资讯列表 paged, category
/getInfomationHotComments POST 获取资讯热门评论 paged
/getInfomationCats POST 获取资讯分类 无需参数
/getInfomationSingle POST 获取资讯单页 post_id
/submitNewsflashes POST 发布快讯 content
/getNewsflashesList POST 获取快讯列表 paged
/getWidgetNewsflashes POST 获取快讯小工具数据 无需参数
问答系统
接口名称 请求方法 功能描述 参数说明
/poAsk POST 发布问题 title, content, category等
/getAskData POST 获取问题数据 post_id
/getAskEditData POST 获取问题编辑数据 post_id
/getAanswerHtml POST 获取答案HTML post_id
/poAskAnswer POST 发布问题答案 post_id, content
/getAnswerData POST 获取答案数据 post_id, paged
/getEditAnswerData POST 获取编辑答案数据 answer_id
/bestAnswer POST 最佳答案 answer_id
分销系统
接口名称 请求方法 功能描述 参数说明
/getMyDistributionData POST 获取分销基本信息 无需参数
/getMyDistributionOrders POST 获取分销订单列表 paged
/getMyPartner POST 获取分销伙伴 paged
举报与安全
接口名称 请求方法 功能描述 参数说明
/shieldAuthor POST 屏蔽作者 author_id
/getDarkRoomUsers POST 获取小黑屋用户 paged
/submitRequest POST 提交工单 type, content, post_id等
/documentVote POST 文档评价 post_id, type
使用示例

基础请求格式

// 获取用户信息
fetch('/wp-json/b2/v1/getUserInfo', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + jwt_token
    },
    body: JSON.stringify({})
})
.then(response => response.json())
.then(data => console.log(data));

分页请求示例

// 获取文章列表（带分页）
fetch('/wp-json/b2/v1/getPostList', {
    method: 'POST',
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify({
        paged: 1,
        posts_per_page: 10,
        category: '分类ID'
    })
})
.then(response => response.json())
.then(data => console.log(data));

文件上传示例

// 上传图片
const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('type', 'image');
fetch('/wp-json/b2/v1/fileUpload', {
    method: 'POST',
    body: formData
})
.then(response => response.json())
.then(data => console.log(data));

用户注册示例

// 用户注册
fetch('/wp-json/b2/v1/regeister', {
    method: 'POST',
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify({
        username: 'testuser',
        password: 'password123',
        email: 'test@example.com',
        code: '123456'
    })
})
.then(response => response.json())
.then(data => {
    if (data.success) {
        console.log('注册成功');
    } else {
        console.log('注册失败:', data.message);
    }
});

注意事项

1. 认证要求

• 大部分接口需要JWT认证，需要在请求头中添加 Authorization: Bearer {token}
• 获取token的方式：用户登录后系统会返回JWT token

2. 参数验证

• 所有接口都有完整的参数验证
• 参数错误会返回详细的错误信息
• 参数类型需要严格按照文档要求

3. 权限控制

• 不同用户角色有不同的API访问权限
• 管理员、普通用户、游客的权限不同
• 部分接口需要特定的用户权限才能访问

4. 安全机制

• 内置频率限制，防止恶意请求
• 验证码验证机制
• 敏感操作需要二次确认

5. 错误处理

• 统一使用WP_REST_Response和WP_Error返回结果
• 成功响应格式：{success: true, data: {...}}
• 错误响应格式：{success: false, message: '错误信息'}

6. 分页参数

• paged: 页码，从1开始
• posts_per_page: 每页数量，默认10

7. 文件上传限制

• 支持图片、文档等文件类型
• 有文件大小限制
• 需要指定文件类型参数

总结

B2主题的REST API设计非常完善，涵盖了社区、商城、内容管理、用户系统等各个方面，总共包含超过150个API接口。这些接口为开发者提供了完整的二次开发能力，可以基于这些API构建各种复杂的Web应用和移动应用。

接口设计遵循RESTful原则，使用标准的HTTP方法和状态码，返回格式统一规范，便于前端开发人员使用。