SuperAPI AI 工具集

documenso-install-auth

通用与其它

查看项目

更新于 10-16 03:38

技能介绍

用途:安装并配置 Documenso SDK 与 API 认证,用于文档签署集成。覆盖 TypeScript SDK(@documenso/sdk-typescript)、Python SDK(documenso-sdk-python)与原始 REST API。Documenso 提供两版 API:v1(旧版,仅文档)与 v2(envelope、多文档,推荐新项目使用)。

前置条件:Node.js 18+ 或 Python 3.10+;包管理器(npm、pnpm、yarn、pip 或 uv);Documenso 账号(云端 app.documenso.com 或自托管实例);在仪表盘生成的 API Key。

安装:TypeScript 用 npm install @documenso/sdk-typescript 或 pnpm add @documenso/sdk-typescript;Python 用 pip install documenso-sdk-python 或 uv pip install documenso-sdk-python。

密钥:登录仪表盘,点击头像选 User settings(或 Team settings 获取团队级密钥),进入 API tokens,点 Create API Key,命名后立即复制(仅显示一次)。团队密钥继承团队文档与模板权限,个人密钥仅访问自己的文档。将密钥写入 .env(勿提交),并把 .env 加入 .gitignore。

初始化:TypeScript v2 用 new Documenso({ apiKey: process.env.DOCUMENSO_API_KEY!, serverURL: ... });v1 REST 用 Authorization: Bearer 头请求;Python 用 Documenso(api_key=os.environ["DOCUMENSO_API_KEY"])。

验证:调用 client.documents.findV0({ page: 1, perPage: 1 }) 检查连接,可用 npx tsx 运行。

端点:云端为 https://app.documenso.com/api/v2(v1 同域 /api/v1);预发布为 stg-app.documenso.com;自托管为 https://your-instance.com/api/v2,需带协议与路径。

错误:401 密钥无效或过期需重新生成;403 个人密钥访问团队资源需换团队密钥;模块未找到需安装 SDK;网络错误检查防火墙或 DNS;ERR_INVALID_URL 检查 serverURL 格式。

安全:密钥仅存环境变量、.env 入 .gitignore、CI 使用加密存储、离职轮换团队密钥、自托管启用 HTTPS。若密钥或签署 URL 泄露,先吊销再调查,不要复用。