Back to Details

documenso-install-auth

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Documenso Install & Auth

Documenso 安装与认证

Overview

概述

Set up Documenso SDK and configure API authentication for document signing integration.
设置Documenso SDK并配置API认证，以实现文档签署集成。

Prerequisites

前置条件

  • Node.js 18+ or Python 3.10+
  • Package manager (npm, pnpm, yarn, pip, or uv)
  • Documenso account (cloud or self-hosted)
  • API key from Documenso dashboard
  • Node.js 18+ 或 Python 3.10+
  • 包管理器（npm、pnpm、yarn、pip或uv）
  • Documenso账户（云端或自托管）
  • 来自Documenso控制台的API密钥

Instructions

操作步骤

Step 1: Install SDK

步骤1：安装SDK

TypeScript/Node.js:
bash
undefined
TypeScript/Node.js：
bash
undefined

npm

npm

npm add @documenso/sdk-typescript
npm add @documenso/sdk-typescript

pnpm

pnpm

pnpm add @documenso/sdk-typescript
pnpm add @documenso/sdk-typescript

yarn

yarn

yarn add @documenso/sdk-typescript
yarn add @documenso/sdk-typescript

bun

bun

bun add @documenso/sdk-typescript

**Python:**
```bash
bun add @documenso/sdk-typescript

**Python：**
```bash

pip

pip

pip install documenso_sdk
pip install documenso_sdk

uv (recommended)

uv（推荐）

uv add documenso_sdk
uv add documenso_sdk

poetry

poetry

poetry add documenso_sdk
undefined
poetry add documenso_sdk
undefined

Step 2: Get API Key

步骤2：获取API密钥

  1. Log into Documenso dashboard at https://app.documenso.com
  2. Click your avatar in the top right corner
  3. Select "User settings" (or "Team settings" for team APIs)
  4. Navigate to "API tokens" tab
  5. Click "Create API Key"
  6. Copy the generated key (shown only once)
  1. 登录Documenso控制台：https://app.documenso.com
  2. 点击右上角的头像
  3. 选择“用户设置”（团队API请选择“团队设置”）
  4. 切换至“API令牌”标签页
  5. 点击“创建API密钥”
  6. 复制生成的密钥（仅显示一次）

Step 3: Configure Authentication

步骤3：配置认证

bash
undefined
bash
undefined

Set environment variable

设置环境变量

export DOCUMENSO_API_KEY="your-api-key"
export DOCUMENSO_API_KEY="your-api-key"

Or create .env file

或创建.env文件

echo 'DOCUMENSO_API_KEY=your-api-key' >> .env
undefined
echo 'DOCUMENSO_API_KEY=your-api-key' >> .env
undefined

Step 4: Verify Connection

步骤4：验证连接

TypeScript:
typescript
import { Documenso } from "@documenso/sdk-typescript";

const documenso = new Documenso({
  apiKey: process.env.DOCUMENSO_API_KEY ?? "",
});

// Verify connection by listing documents
async function verifyConnection() {
  try {
    const documents = await documenso.documents.findV0({});
    console.log("Connection successful!");
    console.log(`Found ${documents.documents?.length ?? 0} documents`);
    return true;
  } catch (error) {
    console.error("Connection failed:", error);
    return false;
  }
}

verifyConnection();
Python:
python
import os
from documenso_sdk import Documenso

documenso = Documenso(
    api_key=os.environ.get("DOCUMENSO_API_KEY")
)
TypeScript：
typescript
import { Documenso } from "@documenso/sdk-typescript";

const documenso = new Documenso({
  apiKey: process.env.DOCUMENSO_API_KEY ?? "",
});

// 通过列出文档验证连接
async function verifyConnection() {
  try {
    const documents = await documenso.documents.findV0({});
    console.log("连接成功！");
    console.log(`找到 ${documents.documents?.length ?? 0} 份文档`);
    return true;
  } catch (error) {
    console.error("连接失败：", error);
    return false;
  }
}

verifyConnection();
Python：
python
import os
from documenso_sdk import Documenso

documenso = Documenso(
    api_key=os.environ.get("DOCUMENSO_API_KEY")
)

Verify connection

验证连接

try: documents = documenso.documents.find_v0() print(f"Connection successful! Found {len(documents.documents)} documents") except Exception as e: print(f"Connection failed: {e}")
undefined
try: documents = documenso.documents.find_v0() print(f"连接成功！找到 {len(documents.documents)} 份文档") except Exception as e: print(f"连接失败：{e}")
undefined

Output

输出结果

  • Installed SDK package in node_modules or site-packages
  • Environment variable or .env file with API key
  • Successful connection verification output
  • 在node_modules或site-packages中安装好SDK包
  • 包含API密钥的环境变量或.env文件
  • 连接验证成功的输出信息

Error Handling

错误处理

ErrorCauseSolution
Invalid API KeyIncorrect or expired keyGenerate new key in dashboard
401 UnauthorizedMissing or malformed keyCheck API key format and env var
403 ForbiddenKey lacks required permissionsUse team API key for team resources
Module Not FoundInstallation failedRun 
npm install
or 
pip install
again
Network ErrorFirewall blockingEnsure outbound HTTPS to api.documenso.com
错误原因解决方案
无效API密钥密钥错误或已过期在控制台生成新密钥
401 未授权缺少密钥或密钥格式错误检查API密钥格式和环境变量
403 禁止访问密钥缺少必要权限针对团队资源使用团队API密钥
模块未找到安装失败重新运行
npm install
或
pip install
网络错误防火墙拦截确保可向api.documenso.com发起HTTPS出站请求

API Endpoints

API端点

EnvironmentBase URL
Production
https://app.documenso.com/api/v2/
Staging
https://stg-app.documenso.com/api/v2/
Self-hosted
https://your-instance.com/api/v2/
环境基础URL
生产环境
https://app.documenso.com/api/v2/
预发布环境
https://stg-app.documenso.com/api/v2/
自托管
https://your-instance.com/api/v2/

Custom Base URL (Self-Hosted)

自定义基础URL（自托管）

typescript
const documenso = new Documenso({
  apiKey: process.env.DOCUMENSO_API_KEY ?? "",
  serverURL: "https://your-documenso-instance.com/api/v2/",
});
typescript
const documenso = new Documenso({
  apiKey: process.env.DOCUMENSO_API_KEY ?? "",
  serverURL: "https://your-documenso-instance.com/api/v2/",
});

Resources

相关资源

Next Steps

后续步骤

After successful auth, proceed to 
documenso-hello-world
for your first document.
认证成功后，请继续执行
documenso-hello-world
完成你的第一份文档操作。