SuperAPI AI 工具集

velt-rest-apis-best-practices

编程与开发

查看项目

更新于 10-16 03:36

技能介绍

用途:面向服务端集成 Velt REST API v2、JWT 认证与 Webhook 的最佳实践指南,适用于后端调用 Velt 接口、为前端用户生成 JWT、处理 Webhook 事件(评论、huddles、CRDT)、服务端管理用户/文档/组织/文件夹,以及实现 GDPR 数据导出或删除等场景。

主要能力:包含 4 个类别、12 条规则。核心设置(CRITICAL):core-rest-api-auth 要求所有 REST 调用携带 x-velt-api-key 与 x-velt-auth-token 请求头;core-jwt-tokens 说明为前端认证生成 JWT,有效期 48 小时并含刷新流程。REST API(HIGH):评论注解与评论 CRUD、用户增删改查及 GDPR 操作、文档/组织/文件夹管理、通知增删改查与配置、活动日志与 CRDT 数据、高级 Webhook 配置启用与端点 CRUD 及签名密钥获取、智能体执行历史分页与状态过滤、记忆判断/知识摄取与搜索/问答/建议/洞察与告警。审批引擎已独立为单独技能。Webhook(MEDIUM):v1 基础设置、事件类型、载荷格式与安全;v2/Svix 企业级 Webhook 的重试与转换。调试(LOW-MEDIUM):后端集成常见问题排查。

使用方式:按优先级从核心设置入手,再依次处理 REST API、Webhook 与调试规则;可先查阅 AGENTS.md 压缩索引,或使用 AGENTS.full.md 查看完整展开指南。

限制:资料未提供具体接口路径、请求体示例、错误码或完整命令,相关细节暂未提供。