关于 bitrix24-rest-api
面向使用 Bitrix24 REST API 的开发者,提供客户端调用、认证、分页、错误处理及事件等实践指南。强调查证方法与权限、安全凭据和幂等处理。
主要功能
- 01REST 调用与分页指南
- 02Webhook、OAuth 与权限说明
- 03限流、错误与重试规则
- 04事件及 REST 3.0 指南
- 05多种 SDK 使用说明
适用场景
- 01为 Bitrix24 云端编写 REST 集成
- 02选择认证方式并配置最小权限
- 03处理批量调用、限流和错误
- 04安全处理事件与入站请求
MCP 相关
项目提到可通过 bitrix24-ai-tools 的 MCP 查找文档,也可在目标门户使用 method.get 查证 API 方法。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ bxmaximum/ bitrix-framework-skills --skill bitrix24-rest-api安装后在 Claude Code 中输入/bitrix24-rest-api确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
rules/auth.mdcalls.mdevents-placements.mdlimits-errors.mdon-premise.mdrest-v3.mdsdk.md详细介绍
Bitrix24 REST API(客户端)
基准:Bitrix24 云端;本地部署版 main 23.0+ · 已验证:rest 26.650.0(main 26.800.0),b24restdocs 2026-09-30
调用 REST。在模块中注册自定义方法:bitrix-rest。供 Agent(MCP)和 Vibecode 查询文档:bitrix24-ai-tools。
| 任务 | 阅读 |
|---|---|
| Webhook、本地应用与 Marketplace OAuth 的区别、令牌刷新、权限范围 | rules/auth.md |
| URL 和请求体格式、列表、快速分页、批处理 | rules/calls.md |
| 限制、错误代码、重试与退避 | rules/limits-errors.md |
| 事件、出站 Webhook、离线事件、嵌入位 | rules/events-placements.md |
REST 3.0(/rest/api/)、Idempotency-Key、OpenAPI | rules/rest-v3.md |
| b24phpsdk、b24jssdk、BX24.js、CRest | rules/sdk.md |
| 本地部署版特性 | rules/on-premise.md |
不变原则
- 切勿猜测方法、字段或筛选条件:务必查询(通过
bitrix24-ai-tools中的 MCP,或在目标门户上调用method.get)。 - Webhook URL、
client_secret、令牌和application_token应存放在环境变量或密钥存储中;切勿放入 VCS、浏览器代码、日志或共享 URL。 - 遵循最小权限原则:只申请场景所需的权限范围。调用也会使用对应用户的权限。
- 根据
error键(以及批处理中result.result_error)检测错误,而不是 HTTP 状态码。 - 在确认
auth.application_token与为其member_id存储的值相符之前,将所有传入调用(事件、嵌入位、安装)视为不可信。 - 仅使用 HTTPS。处理程序应快速确认收到请求,将任务放入队列,并以幂等方式处理。
评论
支持 Markdown