API 接口概述
RocketStack 提供标准的 REST API 接口,支持第三方系统与建站平台进行数据对接与功能集成。接口采用 JSON 数据格式,支持站点信息查询、内容读写、用户认证等常用场景。通过 API 接口,企业可以将官网内容与 CRM、ERP 等业务系统打通,实现数据的统一管理与业务流程的自动化协同。 百度SEO
身份认证方式
API 调用需要通过身份认证获取访问令牌,目前支持 API Key 认证与 OAuth 2.0 授权码两种方式。API Key 适用于服务端到服务端的调用场景,OAuth 2.0 适用于需要用户授权的第三方应用集成场景。
- API Key:在后台生成密钥,请求时通过 Header 携带认证信息
- OAuth 2.0:标准授权码流程,获取 access_token 后调用受保护接口
- 频率限制:单密钥默认每分钟 60 次调用,企业版可申请提升配额
常用接口示例
- 获取站点信息:GET /api/v1/site 返回站点名称、域名与配置摘要
- 获取文章列表:GET /api/v1/articles 支持分页、栏目筛选与关键词搜索
- 获取文章详情:GET /api/v1/articles/{id} 返回文章完整内容与 SEO 字段
- 创建文章:POST /api/v1/articles 提交标题、正文、栏目等字段创建内容
调用注意事项
接口调用失败时请检查认证信息是否正确、请求频率是否超限、参数格式是否符合规范。生产环境建议启用 HTTPS 加密传输,避免敏感数据泄露。详细的接口参数说明与错误码含义请参考 API 文档的接口详情章节。
数据格式与状态码
API 接口统一使用 JSON 格式进行数据传输,字符编码为 UTF-8。成功响应包含 code、message 与 data 三个字段,其中 code 为 0 表示调用成功。常见错误状态码包括 401 认证失败、403 权限不足、404 资源不存在、429 频率超限与 500 服务器内部错误,开发者应根据状态码进行相应的错误处理。 视频引流
分页与排序参数
- page 参数指定页码,per_page 参数指定每页条数,最大不超过 100
- sort 参数支持按发布时间、更新时间与浏览量排序
- order 参数指定排序方向,asc 为升序,desc 为降序
数据写入接口
写入类接口支持创建、更新与删除操作。创建文章时需要提供标题、正文与栏目 ID 等必填字段,SEO 字段为选填项。更新接口采用局部更新机制,只需传入需要修改的字段即可。删除接口为软删除,数据会保留 30 天以便恢复。所有写入操作建议在业务低峰期执行,避免产生数据冲突。 RocketStack
SDK 与工具支持
官方提供了 PHP、Python、Java 三种语言的 SDK 包,封装了认证、请求与响应解析逻辑,开发者可以直接引用 SDK 进行接口调用。同时提供了在线接口调试工具,支持构造请求、查看响应与生成调用代码,大幅降低对接成本。接口文档会随系统版本同步更新,请以最新版本文档为准。 SEO教程