# @dimo-network/data-sdk 中文文档

规范地址：https://npmcn.com/package/%40dimo-network/data-sdk/

版本：1\.8\.0
npm 元数据更新时间：2026-11-06T18:31:09.155Z
中文译文更新时间：2026-11-12T09:58:32.795Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40dimo-network/data-sdk
原文对照：https://npmcn.com/package/%40dimo-network/data-sdk/?lang=original
项目主页：https://dimo.org/
源码仓库：https://github.com/DIMO-Network/data-sdk

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

- 包体积（解压后）：262 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2024-11-14T20:39:53.618Z
- 最新版本发布：2026-11-06T18:31:08.753Z
- 近 30 天下载量：2958（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 5 个）

## 中文简介

JavaScript 的 DIMO 数据 SDK

## 安装

```sh
npm install @dimo-network/data-sdk
```

也可以使用：`pnpm add @dimo-network/data-sdk`、`yarn add @dimo-network/data-sdk`、`bun add @dimo-network/data-sdk`

## README

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/dimo-network/data-sdk/npm-publish.yml?style=flat-square) ![GitHub top language](https://img.shields.io/github/languages/top/dimo-network/data-sdk?style=flat-square) ![GitHub License](https://img.shields.io/github/license/dimo-network/data-sdk?style=flat-square) [![Downloads](https://img.shields.io/npm/d18m/@dimo-network/data-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@dimo-network/data-sdk) [![Discord](https://img.shields.io/discord/892438668453740634)](https://chat.dimo.zone/) ![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FDIMO_Network&style=social)

# DIMO（智猛）Data SDK

## 概述

DIMO Data SDK 是一個以 TypeScript 構建的官方函式庫，旨在讓開發者能夠簡單且高效地使用 DIMO API。此 SDK 減少了開發者在整合 DIMO 平台時的複雜性，並加速開發過程。透過 API 調用的抽象化、簡化數據操作以及提供強大的型別安全性，提升了開發者的使用體驗。

## 安裝

使用 [npm](https://www.npmjs.com/package/@dimo-network/data-sdk):

```bash
npm install @dimo-network/data-sdk
```

使用 [yarn](https://classic.yarnpkg.com/en/package/@dimo-network/data-sdk):

```bash
yarn add @dimo-network/data-sdk
```

## 單元測試

執行 `npm test` 或 `npm run test` 來運行 Jest 測試。

## API 文件

有關 DIMO 開發或 API 的詳細資訊，請參閱 DIMO 的 [開發者文件](https://docs.dimo.org/developer-platform)。

## SDK 使用方法

### 訪問函式庫

(TypeScript / ES Modules)

```ts
import { DIMO } from '@dimo-network/data-sdk';
```

(CommonJS)

```js
const { DIMO } = require('@dimo-network/data-sdk')
```

### SDK 初始化

```ts
const dimo = new DIMO('Production');
```

### 開發者註冊

作為認證流程的一部分，您需要先通過 [DIMO Developer Console](https://console.dimo.org/) 獲取開發者授權身份。請按照以下步驟開始註冊：

1.  造訪 [DIMO 開發者主控台](https://console.dimo.org/) 並註冊帳號。
2.  點擊「創建執照」（Create a License），並輸入您的相關執照詳細資訊。
3.  生成 API 金鑰（API Key），並新增所需的統一資源識別碼（Redirect URI）。

### 開發者認證

SDK 提供了[認證流程](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication) 所需的所有步驟，幫助您獲取「開發者 JWT」（Developer JWT）以及每輛與應用程式共享的車輛所使用的「車輛 JWT」（Vehicle JWT）。

#### 認證的前置條件

1.  開發者執照
2.  API 金鑰以及至少一組自訂的統一資源識別碼（Redirect URI）
3.  適當的 [TypeScript 環境設置](https://learn.microsoft.com/zh-tw/visualstudio/javascript/compile-typescript-code-npm?view=vs-2022)。

#### 開發者 JWT

```ts
const developerJwt = await dimo.auth.getDeveloperJwt({
    client_id: '<client_id>',
    domain: '<domain/redirect_uri>',
    private_key: '<api_key>',
});
```

#### 車輛 JWT

若要從消費者處獲取車輛數據，應用程式需要交換短期有效的 [車輛 JWT](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication#getting-a-jwt)。此車輛 JWT 是針對授權應用程式的車輛生成的。

消費者需要事先與您的應用程式共享車輛授權。為此，您可以透過前端整合 [Login with DIMO](https://docs.dimo.org/developer-platform/getting-started/developer-guide/login-with-dimo) 或開發出類似 DIMO Mobile 全端的功能。完成「分享」此步驟後，您將能夠自由獲取車輛數據。

```ts
const vehicleJwt = await dimo.tokenexchange.getVehicleJwt({
    ...developerJwt,
    tokenId: 117315
});
```

## SDK 貢獻

有關如何貢獻於此 SDK 的詳細資訊，請參閱[此處](https://github.com/DIMO-Network/data-sdk/blob/master/CONTRIBUTING.md)。

## 常见问题

### @dimo-network/data-sdk 是什么？

JavaScript 的 DIMO 数据 SDK

### 如何安装 @dimo-network/data-sdk？

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

### @dimo-network/data-sdk 支持 TypeScript 吗？

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

### @dimo-network/data-sdk 支持 ESM 还是 CommonJS？

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

### @dimo-network/data-sdk 可以商用吗？

@dimo-network/data-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dimo-network/data-sdk 的下载量有多少？

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

### @dimo-network/data-sdk 还在维护吗？

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