开发者概览

Developer 页面提供 Shifton API 文档和创建自定义集成工具的访问入口。

分步说明

访问 Developer 页面

使用 Overview 选项卡

点击所需链接——文档将在新标签页中打开。

其他 Developer 选项卡

相关文章

• 可用集成
• Webhooks
• 自定义应用
• 权限级别和角色

常见问题

问：应该使用哪个文档——新的还是旧的？
所有新集成请使用 新文档。旧文档仅用于向后兼容。

问：开发者 页面不显示——为什么？
该页面仅对 Owner 和 可用。

问：API 请求数量是否有限制？
有。详情请参阅 API 文档。

问：在哪里找到 轮班on API 的 API 密钥？
Integrations → 开发者 → 申请 → 创建应用 → 在设置中获取 API 凭据。

问：轮班on 是否支持 OAuth 2.0？
是的。通过 OAuth 授权连接第三方应用。详情请参阅 API 文档。

问：能否不创建应用就测试 API？
可以——使用 Postman 等工具配合您的凭据。生产环境建议注册应用。

问：新文档 和 旧文档 有什么区别？
新文档——最新版本（推荐用于所有新集成）。旧文档——用于与现有集成的向后兼容。

问：能否通过 API 获取报表数据？
可以。Shifton API 提供排班、员工和其他资源的数据访问。详情请参阅文档。

问：Webhook 是否支持所有 轮班on 事件类型？
不是，仅支持特定类型。支持的事件列表在 Developer → Webhooks 文档部分。

问：使用 API 是否需要技术知识？
是的。使用 REST API 和通过 Applications 创建集成需要基本的开发技能。

问：API 是付费的还是包含在订阅中？
API 包含在订阅中，无额外费用。限制取决于订阅计划。

问：API 集成遇到问题如何获取支持？
请联系 Shifton 支持，提供请求、响应和错误代码的描述。同时查阅 Developer 页面的文档。

问：轮班on API 的基础 URL 是什么？
基础 URL 是 api2.shifton.com。详情和请求示例请参阅 新文档。

问：API 在请求大型列表时是否支持分页？
是的。分页实现的详情请参阅 API 文档。

问：能否通过 API 创建和删除班次？
可以。API 提供对班次、员工、排班和其他资源的完整 CRUD 访问。

问：是否有用于测试 API 的沙箱环境？
没有专门的沙箱环境。建议在 Shifton 中创建测试公司进行安全测试。

问：API 支持哪些数据格式？
API 使用 JSON 格式进行请求和响应。