SuperAPI AI 工具集

documenso-sdk-patterns

编程与开发

查看项目

更新于 10-15 23:25

技能介绍

用途:为 Documenso 集成提供可上生产环境的 SDK 使用范式,适用于实现集成、重构 SDK 用法或建立 SDK 边界时参考。覆盖 TypeScript SDK(@documenso/sdk-typescript)与 Python SDK。

主要能力:

  1. 单例客户端:通过 getDocumensoClient 复用实例,从配置或环境变量 DOCUMENSO_API_KEY 取密钥,缺失时抛错;提供 resetClient() 便于测试与密钥轮换后重置。
  2. 类型化文档服务:定义创建文档入参(标题、PDF 路径、签署人及字段类型 SIGNATURE/INITIALS/NAME/EMAIL/DATE/TEXT 与坐标),依次调用 documents.createV0、setFileV0 上传 PDF、documentsRecipients.createV0 添加签署人、documentsFields.createV0 添加字段、sendV0 发送。
  3. 错误封装:将状态码映射为 DocumensoError,并标记是否可重试。401 无效密钥、403 权限不足(建议团队级 API key)、404 资源不存在不可重试;429、500、502、503 可重试。
  4. 重试:withRetry 使用指数退避加抖动,默认最多 3 次、基础延迟 1000ms、上限 30000ms,仅对可重试错误生效。
  5. Python 服务:DocumensoService 类封装 create_and_send,逻辑与 TS 版本对应。
  6. 测试:用 vitest 创建 Mock 客户端,避免真实请求;断言请求形状,仅记录关联 ID 与生命周期状态,不记录文档或签署人负载。

适用场景:Documenso 集成开发、SDK 用法重构、建立 SDK 边界与测试策略。

限制与前置:需先完成 documenso-install-auth 设置,熟悉 async/await、TypeScript 泛型与错误处理最佳实践。文中示例 API 方法与参数以资料为准,价格、配额、平台支持等暂未提供。切勿记录签署 URL、文档内容、签署人 PII 或凭据。