# @docutain/capacitor-plugin-docutain-sdk 中文文档

规范地址：https://npmcn.com/package/%40docutain/capacitor-plugin-docutain-sdk/

版本：7\.0\.0
npm 元数据更新时间：2025-10-14T11:21:32.607Z
中文译文更新时间：2026-11-13T05:21:13.093Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40docutain/capacitor-plugin-docutain-sdk
原文对照：https://npmcn.com/package/%40docutain/capacitor-plugin-docutain-sdk/?lang=original
项目主页：https://github.com/Docutain/docutain-sdk-example-capacitor-ionic#readme
源码仓库：https://github.com/Docutain/docutain-sdk-example-capacitor-ionic

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

- 包体积（解压后）：256 kB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=7\.0\.0
- 首次发布：2023-10-05T14:59:52.888Z
- 最新版本发布：2025-10-14T11:21:32.420Z
- 近 30 天下载量：2205（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 0 个）

## 中文简介

Docutain文档扫描器SDK用于Android和iOS的电容插件. 高级文档扫描,数据提取,文本识别以及您的应用程序的PDF创建. 轻松扫描应用程序中的文档 .

## 安装

```sh
npm install @docutain/capacitor-plugin-docutain-sdk
```

也可以使用：`pnpm add @docutain/capacitor-plugin-docutain-sdk`、`yarn add @docutain/capacitor-plugin-docutain-sdk`、`bun add @docutain/capacitor-plugin-docutain-sdk`

## README

# 用于控制器的 Docutain SDK

## 预览

![Capacitor Docutain SDK for high quality, high performance document scanning and data extraction. Use the document scanner in various industries, e.g. scanning BOLs, invoice scan and much more.](https://docs.docutain.com/assets/images/ScanEditUI-b57833e318cfd8f246317a5d693e6a22.png)

## 什么是Docutain SDK吗?

这个 [Docutain SDK 文档](https://sdk.docutain.com/) 为您的应用程序带来自动文档扫描、数据捕获、图像处理、OCR文本识别、智能数据提取、PDF创建和照片支付等功能.

它的工作100%离线,确保了最大数据安全.

它包含个人许可模块:

-   [文档扫描器 SDK](https://sdk.docutain.com/document-scanner-sdk)
-   [OCR SDK 用于文本识别](https://sdk.docutain.com/data-capture-sdk)
-   [数据采集和提取 SDK](https://sdk.docutain.com/data-capture-sdk)
-   [照片支付 SDK](https://sdk.docutain.com/fotoueberweisung)

详情请访问我们的网站 [https://sdk.docutain.com (中文(中国大陆) )](https://sdk.docutain.com/)

如果您喜欢在不写代码的情况下测试功能, 请检查我们 [显示大小写应用程序](https://sdk.docutain.com/#Test)。 。 。 .

## 插件版本

| 电容版本 | 插件版本 |
| --- | --- |
| 7.x 电话 | 7.x 电话 |
| 6.x (单位:千美元) | 6.x (单位:千美元) |
| 5.x 电话 | 1.x 运算 |

## 使用量

以下是使用文档扫描仪的最小示例. 对于所有可用的功能和主题可能性,请检查我们 [文档](https://docs.docutain.com/docs/capacitor/intro)。 。 。 .

### 初始化

要使用SDK的任何功能,必须先初始化.

```jsx
try{
    await DocutainSDK.initSDK({licenseKey: "<YOUR-LICENSE-KEY>"})
} catch (error) {
    //init of Docutain SDK failed, get the last error message
    console.error(error);
    //your logic to deactivate access to SDK functionality
}
```

为测试目的,可以将许可密钥空出. 然而,SDK将在1分钟后停止工作. 你可以免费延长审判执照 [网站](https://sdk.docutain.com/TrialLicense?Source=1289)。 。 。 .

### 启动扫描仪扫描文档

在iOS上,确保添加相机使用描述 `Info.plist`如果你不这样做,应用程序会崩溃.

```jsx
NSCameraUsageDescription - "In order to scan documents, you need to grant permission to access the camera."
```

要启动文档扫描器,只需拨打 `DocutainSDK.startDocumentScanner` 等待它回来.

看看这个 [文档](https://docs.docutain.com/docs/capacitor/docScan#change-default-scan-behaviour) 用于可能的扫描配置.

```jsx
try{
    await DocutainSDK.startDocumentScanner({
        //customize the scanner config according to your needs
    });
} catch (error) {
    if ((error as { code?: string })?.code === 'CANCELED') {
        //user canceled scan process
        console.log(`user canceled`);
    } else {
        console.error(error);
    }
}
```

### 生成 PDF 文档

用户完成扫描后,可以从扫描页面中生成PDF文档. PDF 文档将包含公认的文本,使其可以搜索和选择.

看看这个 [文档](https://docs.docutain.com/docs/capacitor/pdfCreation) 更多细节.

```jsx
try{    
    const pdfUri = (await DocutainSDK.writePDF({
        fileUri: destinationUri,
        overWrite: true,
    })).fileUri 
} catch (error) {
    console.error(error);
}  
```

### 图像导出

还有可能将扫描页作为单一的图像文件.

看看这个 [文档](https://docs.docutain.com/docs/capacitor/imageExport) 更多细节.

```jsx
try{
    const pageCount = (await DocutainSDK.pageCount()).count;
    for(let i = 1; i <= pageCount; i++){
        const imageUri = (await DocutainSDK.writeImage({
            pageNumber: i,
            fileUri: destinationUri
        })).fileUri
    }
}catch (error) {
    console.error(error);
} 
```

### 文本识别

用一行代码,就可以得到被扫描文档或单页的被识别文本.

看看这个 [文档](https://docs.docutain.com/docs/capacitor/textDetection) 更多细节.

```jsx
try{
    const text = (await DocutainSDK.getText()).text
}catch (error) {
    console.error(error);
} 
```

### 数据提取

还可以在扫描上进行数据提取,以提取某些值,如地址、数量、IBAN、日期等.

看看这个 [文档](https://docs.docutain.com/docs/capacitor/dataExtraction) 更多细节.

```jsx
try{
    const analyzeData = (await DocutainSDK.analyze()).data;
}catch (error) {
    console.error(error);
} 
```

### 照片支付

在几分钟内将照片支付纳入您的银行应用程序, 只需要几行代码。 它在设备上100%的离线。 没有数据被传输到任何外部服务器或云端服务,确保了数据100%的保护.

看看这个 [文档](https://docs.docutain.com/docs/capacitor/photoPayment) 更多细节.

```jsx
try{
    const result = await DocutainSDK.startPhotoPayment({
        //customize the photo payment process according to your needs
    });
    if(result.data !== ""){
        //payment information has been extracted
        //result.data is a JSON string containing the information
        //extract the fields you need and pass it on to your payment sheet
    } else{
        //no data was extracted at all
        //Note: this case is only reachable, if you disabled the Empty Result Screen
    }
} catch (error) {
    if ((error as { code?: string })?.code === 'CANCELED') {
        //user canceled scan process
        console.log(`user canceled`);
    } else {
        console.error(error);
    }
}    
```

## 文档文件

这个 [文档](https://docs.docutain.com/docs/capacitor/intro) 包括您需要知道的所有将 Docutain SDK 整合到您的 Capacitor 应用程序中。 如果您喜欢样本项目而不是文档, 请检查我们的 Docutain SDK Capacitor 样本应用程序 [吉图布](https://github.com/Docutain/docutain-sdk-example-capacitor-ionic)。 。 。 .

## 更改日志

每个版本中包含的所有更改均可在此找到: [更改日志](https://docs.docutain.com/docs/capacitor/changelog)

## 许可证和支助

Docutain SDK是一种商业产品,生产使用需要付费许可证。 为了获得审判许可证,请通过 [https://sdk.docutain.com/ 审案资料](https://sdk.docutain.com/TrialLicense?Source=1289) 生成试用许可证密钥.

如果你需要任何技术支持,请通过 [支持. sdk@Docutain.com](mailto:support.sdk@Docutain.com)。 。 。 .

## 常见问题

### @docutain/capacitor-plugin-docutain-sdk 是什么？

Docutain文档扫描器SDK用于Android和iOS的电容插件\. 高级文档扫描,数据提取,文本识别以及您的应用程序的PDF创建\. 轻松扫描应用程序中的文档 \.

### 如何安装 @docutain/capacitor-plugin-docutain-sdk？

在项目目录运行 npm install @docutain/capacitor-plugin-docutain-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=7\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @docutain/capacitor-plugin-docutain-sdk 支持 TypeScript 吗？

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

### @docutain/capacitor-plugin-docutain-sdk 支持 ESM 还是 CommonJS？

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

### @docutain/capacitor-plugin-docutain-sdk 可以商用吗？

@docutain/capacitor-plugin-docutain-sdk 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @docutain/capacitor-plugin-docutain-sdk 的下载量有多少？

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

### @docutain/capacitor-plugin-docutain-sdk 还在维护吗？

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