# @apideck/node 中文文档 规范地址：https://npmcn.com/package/%40apideck/node/ 版本：3\.8\.0 npm 元数据更新时间：2026-09-17T09:13:35.178Z 中文译文更新时间：2026-11-06T10:00:46.849Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40apideck/node 原文对照：https://npmcn.com/package/%40apideck/node/?lang=original 项目主页：https://apideck.com/ 源码仓库：https://github.com/apideck-libraries/node-sdk ## 关键信息（来自 npm 元数据） - 包体积（解压后）：21.2 MB，1447 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - Node.js 要求：\>=10 - 运行依赖：1 个 - 首次发布：2021-03-25T11:39:27.275Z - 最新版本发布：2025-03-17T08:23:52.354Z - 近 30 天下载量：27613（2026-10-06 至 2026-11-04，npm 官方下载统计） - 已发布版本数：91（近 12 个月 0 个） ## 中文简介 Apideck 节点.js SDK ## 安装 ```sh npm install @apideck/node ``` 也可以使用：`pnpm add @apideck/node`、`yarn add @apideck/node`、`bun add @apideck/node` ## README # Apideck 节点.js SDK > ⚠️ **废弃通知**:此SDK已贬值,将于2025年5月31日存档. 请向 [新建 SDK](https://github.com/apideck-libraries/sdk-typescript) 在这个日期之前 在2025年5月31日之后,这个寄存器将被存档,不再收到任何更新. 为了在过渡期间支持你,请参见我们 [移徙指南](https://developers.apideck.com/guides/sdk-migration)。 。 。 . ## 目录 - [目录](https://npmcn.com/package/%40apideck/node/#readme-table-of-contents) - [安装](https://npmcn.com/package/%40apideck/node/#readme-installation) - [开始](https://npmcn.com/package/%40apideck/node/#readme-getting-started) - [示例](https://npmcn.com/package/%40apideck/node/#readme-example) - [支助](https://npmcn.com/package/%40apideck/node/#readme-support) - [许可证](https://npmcn.com/package/%40apideck/node/#readme-license) ## 安装 使用 npm 安装最新的 SDK : ```console $ npm install @apideck/node ``` 或者亚伦 ```console $ yarn add @apideck/node ``` ## 开始 该模块支持所有Apideck API端点. 关于API的完整信息, 头 页:1 [文档](https://developers.apideck.com/)。 。 。 . ### 配置 一个新的 Apideck 实例通过在所需的设置中传递到配置中而初始化 . ```typescript import Apideck from '@apideck/node'; const apideck = new Apideck({ apiKey: '', appId: '', consumerId: '' }) const { crm } = apideck ``` 顶级参数(apiKey除外)可以在特定资源调用中被覆盖. ```typescript // Declare Unify Api to use const { crm } = apideck // Override consumerId serviceId as declared in initial configuration for this operation. const response = await crm.contactsAll({ // serviceId: 'salesforce', // optional limit: '10' }) ``` ## 示例 获取所有联系人列表并用新地址更新第一个记录 . ```typescript import Apideck, { PhoneNumberType } from '@apideck/node'; const apideck = new Apideck({ apiKey: '', appId: '', consumerId: '' }) const { crm } = apideck const { data } = await crm.contactsAll({ limit: 10 }) const result = await crm.contactsUpdate({ id: data[0].id!, contact: { name: "John Doe", first_name: "John", last_name: "Doe", addresses: [{ city: "Hoboken", line1: "Streetname 19", state: "NY" }], phone_numbers: [{ number: '0486565656', phoneType: PhoneNumberType.Home }] } }) console.info(result) ``` ## Apideck 统一爱皮斯 目前有以下Apis: ### 会计Api 读取 AccountApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/AccountingApi.md)。 。 。 . ### 阿兹阿皮 读取 AtsApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/AtsApi.md)。 。 。 . ### 连接符Api 读取连接符Api的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/ConnectorApi.md)。 。 。 . ### CrmApi 图像 读取 CrmApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/CrmApi.md)。 。 。 . ### 电子商务Api 读取 EcommerceApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/EcommerceApi.md)。 。 。 . ### 文件图像Api 读取文件StorageApi的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/FileStorageApi.md)。 。 。 . ### 红外线 读取 HrisApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/HrisApi.md)。 。 。 . ### 问题跟踪Api 读取问题跟踪的完整文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/IssueTrackingApi.md)。 。 。 . ### 铅Api 读取 leadApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/LeadApi.md)。 。 。 . ### 波斯阿皮语Name 读取 PosApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/PosApi.md)。 。 。 . ### 斯姆萨皮语Name 读取 SmsApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/SmsApi.md)。 。 。 . ### 默认阿皮 读取 VaultApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/VaultApi.md)。 。 。 . ### 网络地图Api 读取 WebhookApi 的全部文档 [这里](https://npmcn.com/package/%40apideck/node/src/gen/docs/apis/WebhookApi.md)。 。 。 . ### 用户 #### 上传文件 使用文件存储 API 上传文件的工具 . `uploadFile` 将自动为大于 4MB 的文件使用上传会话。 较小的文件会用简单的上传呼叫上传. **示例使用** ```ts const apideck = new Apideck({ apiKey: '', appId: '', consumerId: '' }); const file = await apideck.utils.uploadFile({ serviceId: 'dropbox', file: buffer, // Buffer | string name: "test.jpg", size: fileSize, // file size in bytes contentType: "image/jpg", // optional }); ``` ## 支助 打开一个 [问题](https://github.com/apideck-libraries/node-sdk/issues/new)来啊! ## 许可证 [阿帕奇 - 2.0](https://github.com/apideck-libraries/node-sdk/blob/main/LICENSE) ## 常见问题 ### @apideck/node 是什么？ Apideck 节点\.js SDK ### 如何安装 @apideck/node？ 在项目目录运行 npm install @apideck/node，或使用 pnpm add / yarn add / bun add。 ### @apideck/node 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @apideck/node 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @apideck/node 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=10。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @apideck/node 可以商用吗？ @apideck/node 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @apideck/node 的下载量有多少？ 根据 npm 官方下载统计，@apideck/node 在 2026/10/06 – 2026/11/04 这 30 天内被下载 27,613 次，日均约 920 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @apideck/node 还在维护吗？ 最新版本 3\.8\.0 发布于 2025/03/17（1\.6 年前）；至今共发布 91 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/03/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。