# @assinafy/sdk 中文文档

规范地址：https://npmcn.com/package/%40assinafy/sdk/

版本：3\.0\.2
npm 元数据更新时间：2026-11-12T17:45:59.356Z
中文译文更新时间：2026-11-13T04:45:27.384Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40assinafy/sdk
原文对照：https://npmcn.com/package/%40assinafy/sdk/?lang=original
项目主页：https://www.assinafy.com.br/
源码仓库：https://github.com/assinafy/typescript-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2 MB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- 首次发布：2026-05-28T16:00:55.164Z
- 最新版本发布：2026-11-12T17:45:58.988Z
- 近 30 天下载量：2296（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 25 个）

## 中文简介

Assinafy API 的 SDK 类型 - 数字签名平台

## 安装

```sh
npm install @assinafy/sdk
```

也可以使用：`pnpm add @assinafy/sdk`、`yarn add @assinafy/sdk`、`bun add @assinafy/sdk`

## README

# @ assinafy/ sdk

_· 葡萄牙 [以英语阅读](https://npmcn.com/package/%40assinafy/sdk/README.en.md)_

SDK 官方格式文件第a段 [API 阿西纳菲](https://api.assinafy.com.br/v1/docs),com suporte 时 a 节点js e Bun, tipos completos e 建立无害环境管理/CJS.

O SDK Mapeia 为147个歌剧 çõ do OpenAPI publicado (146 com métodos; a troca da sessão incorporada) 安置在阿西纳菲的 " 保护 " 组织、 " 保护 " 组织 pela API. (原始内容存档于2018-09-21). 共载荷 后置装置 错误 或 例子 **[手动端口](https://npmcn.com/package/%40assinafy/sdk/docs/README.md)**。 。 。 .

## 请求

-   节点.js 22+ u Bun 1.4.4
-   HTTPS com TLS 1.2 优等级

## 英斯特拉桑

```bash
npm install @assinafy/sdk
# ou
bun add @assinafy/sdk
```

## 伊尼西奥·拉皮多

```ts
import { AssinafyClient } from '@assinafy/sdk';

const client = new AssinafyClient({
  apiKey: process.env.ASSINAFY_API_KEY!,
  accountId: process.env.ASSINAFY_ACCOUNT_ID!,
});

const resultado = await client.uploadAndRequestSignatures({
  source: { filePath: './contrato.pdf' },
  signers: [
    {
      name: 'Signatário Exemplo',
      email: 'signatario@exemplo.com.br',
    },
  ],
  message: 'Por favor, assine este contrato',
});

console.log(resultado.document.id, resultado.assignment.id);
```

O Helper envia o PDF, cria ou recerroveita os signatários e programa assinaturas. 中国植物物种信息数据库. 参数控制器 卡达和帕帕分离, siga o [通通通算作文档](https://npmcn.com/package/%40assinafy/sdk/docs/README.md#ciclo-de-vida-do-documento)。 。 。 .

## 厄立特里亚

| 证书 | 乌苏 |
| --- | --- |
| `apiKey` | 无工作空间自动服务器 |
| `token` | Sessão autenticada o de acesso OAuth 维基语录链接:名人名言 - 文学作品 - 谚语 - 电影对白 - 主题 - 主题 - 主题 - 主题 |
| 证书 | 登入、登入、登入、登入、登入 |

```ts
const comChave = new AssinafyClient({
  apiKey: process.env.ASSINAFY_API_KEY!,
  accountId: process.env.ASSINAFY_ACCOUNT_ID!,
});

const comOAuth = new AssinafyClient({
  token: process.env.ASSINAFY_ACCESS_TOKEN!,
  accountId: process.env.ASSINAFY_ACCOUNT_ID!,
});
```

Aplica'es concidadas a workspaces de terceiros devem usar OAuth 2.1 com PKCE S 256 (英语). 维雅o [奥奥特](https://npmcn.com/package/%40assinafy/sdk/docs/README.md#aplica%C3%A7%C3%B5es-oauth) \* 载于e/cn.4/sub.2/2003/l.10号文件 刷新令牌 e revogação.

## 配置

| 页:1 | 帕德罗 | 定稿 |
| --- | --- | --- |
| `apiKey` | —— 说 | 证书 `X-Api-Key` |
| `token` | —— 说 | 证书 `Authorization: Bearer` |
| `accountId` | —— 说 | 工作空间 |
| `baseUrl` | `https://api.assinafy.com.br/v1` | Anbiente da API (法语) |
| `webhookSecret` | —— 说 | Asinatura 标准网页 |
| `timeout` | `30000` | 暂停 em milissegundos |
| `maxRetries` | `2` | HTTP 429段 |
| `logger` | 无 -op | 逻辑 |

欧 [手册](https://npmcn.com/package/%40assinafy/sdk/docs/README.md#configura%C3%A7%C3%A3o) (原始内容存档于2018-10-25) (英语). explica retentives, limites e fábricas.

## 通商银行

1.  配置 o cliente com uma chave de API ou conclua o 通量 OAuth 没有 mesmo 环境 工作空间.
2.  (原始内容存档于2018-10-21). Crie ou location os signatários.
3.  Envie o PDF e guarde o processamento dos medados. 中国植物物种信息数据库.
4.  (原始内容存档于2019-09-26) (英语). Estime o custo e crie o assign com a verificação an notificação desejadas, ou envie vários as signalatários de uma vez com 互联网档案馆的存檔,存档日期2014-12-02 `client.envelopes`。 。 。 .
5.  启动 URL 的 Assinatura, ou exiba a tela de Assinatura dentro do seu app com , 启动一个 URL 的 Assinatura, ou exiba a tela de assinatura dentro do seu app com , 启动一个 URL 的 Asinatura , 启动一个 app com `client.embed`, e 有效的 os webhooks antes de processar 事件.
6.  (原始内容存档于2013-10-12). Acompany a conclusão e baixe o documento assinado ou o certificado.

(原始内容存档于2018-10-21) (英语). WhatsApp, biometria com documento e face, certificado digital ICP-Brasil e a vificaço `Bypass` (f) 科学、技术和科学; `workspaces.get(id, { expand: 'signing_features' })` {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}通知我们 {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}我们得去调查一下 O SDK 代表 A1 e A3 como `DigitalCertificate`a midia é escolhida pelo) 互联网档案馆的存檔,存档日期2013-12-21 诺拉塔里奥 诺瓦加多 咨询 [拉莫斯·德·阿西纳图拉](https://npmcn.com/package/%40assinafy/sdk/docs/README.md#ramos-pagos-de-assinatura)。 。 。 .

## 缩写 API

| 重现 | 阿雷亚 |
| --- | --- |
| `client.documents` | 上传、咨询a、蒿、标记 e criação por 模板 |
| `client.signers` | 卡达斯特罗(Cadastro),公交车(busca e atualização de signatários) |
| `client.assignments` | 索利西塔 克托斯 克托斯 克托斯 克托斯 克托斯 克托斯 |
| `client.envelopes` | (原始内容存档于2018-10-21) (英语). Vários documentos as mesmos signalatários, um convite e uma cobrança |
| `client.embed` | Origens e sessães de uso único para assinar dentro do seu app. (原始内容存档于2018-03-31) (英语) |
| `client.contracts` | Termos, Famílias, 重建与重建 |
| `client.templates`, (中文(简体) ), `client.tags`, (中文(简体) ), `client.fields` | Conteúdo reutilizável e campos 互联网档案馆的存檔,存档日期2013-12-02 |
| `client.workspaces`, (中文(简体) ), `client.users` | 工作空间,Tema, uso do plano, política de nitifica'es, 偏好 外交部/TOTP |
| `client.auth`, (中文(简体) ), `client.oauth` | 登录、通道、 API e OAuth 2.1 |
| `client.webhooks`, (中文(简体) ), `client.webhookVerifier` | 终止点、终止点和终止点 |
| `client.signerDocuments` | 福克多·普布利克·奥兰蒂卡多(Fluxo público e autenticado do signatário) |

维雅a [国家](https://npmcn.com/package/%40assinafy/sdk/docs/README.md#refer%C3%AAncia-de-recursos) e 个 [歌剧地图](https://npmcn.com/package/%40assinafy/sdk/docs/API_COVERAGE.md)。作为声明的文本 e o JSDoc distribuídos com o pacote 文档am os 有效载荷.

## 文件

-   [手动缩写 em português](https://npmcn.com/package/%40assinafy/sdk/docs/README.md)
-   [完整的英文手册](https://npmcn.com/package/%40assinafy/sdk/docs/README.en.md)
-   [科贝尔图拉·达API](https://npmcn.com/package/%40assinafy/sdk/docs/API_COVERAGE.md)
-   [环境兼容性](https://npmcn.com/package/%40assinafy/sdk/docs/COMPATIBILITY.md)
-   [解禁进程](https://npmcn.com/package/%40assinafy/sdk/docs/RELEASING.md)
-   [官方文件](https://api.assinafy.com.br/v1/docs)

## 德森沃尔维门托

```bash
bun install --frozen-lockfile
bun run verify
bun run audit
bun run audit:api
```

`bun run verify` 切卡吉姆·德·皮托斯 林特克 考斯克 科博图拉 造出活塞.

## 语法

公民权利协会 [麻省理工学院](https://npmcn.com/package/%40assinafy/sdk/LICENSE)。 。 。 .

## 常见问题

### @assinafy/sdk 是什么？

Assinafy API 的 SDK 类型 - 数字签名平台

### 如何安装 @assinafy/sdk？

在项目目录运行 npm install @assinafy/sdk，或使用 pnpm add / yarn add / bun add。

### @assinafy/sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @assinafy/sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @assinafy/sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @assinafy/sdk 可以商用吗？

@assinafy/sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @assinafy/sdk 的下载量有多少？

根据 npm 官方下载统计，@assinafy/sdk 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,296 次，日均约 77 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @assinafy/sdk 还在维护吗？

最新版本 3\.0\.2 发布于 2026/11/13（今天）；至今共发布 25 个版本，其中过去 12 个月发布了 25 个；首次发布于 2026/05/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。