# @cryptlex/web-api-client 中文文档

规范地址：https://npmcn.com/package/%40cryptlex/web-api-client/

版本：1\.2\.1
npm 元数据更新时间：2023-10-25T11:20:47.617Z
中文译文更新时间：2026-11-11T06:37:45.776Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40cryptlex/web-api-client
原文对照：https://npmcn.com/package/%40cryptlex/web-api-client/?lang=original
项目主页：https://github.com/cryptlex/web-api-client-js#readme
源码仓库：https://github.com/cryptlex/web-api-client-js

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

- 包体积（解压后）：99.3 kB，52 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>= 14\.13
- 运行依赖：1 个
- 首次发布：2022-11-29T10:04:46.900Z
- 最新版本发布：2023-10-25T11:20:47.431Z
- 近 30 天下载量：2784（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

Cryptlex Web API 客户端库

## 安装

```sh
npm install @cryptlex/web-api-client
```

也可以使用：`pnpm add @cryptlex/web-api-client`、`yarn add @cryptlex/web-api-client`、`bun add @cryptlex/web-api-client`

## README

# @cryptlex/web-api-客户端

[![latest-npm-version](https://badge.fury.io/js/@cryptlex%2Fweb-api-client.svg)](https://www.npmjs.com/package/@cryptlex/web-api-client) ![build](https://github.com/cryptlex/web-api-client-js/actions/workflows/release.yml/badge.svg)

Cryptlex Web API客户端库提供从用 JavaScript 编写的应用程序获取 Cryptlex Web API 的权限. 库维护支持 TypeScript(% 3.5) 的类型.

# 所需资源

节点14或以上

# 安装

```
npm install @cryptlex/web-api-client
```

# 使用量

库需要配置一个有效的访问符. 这是在 `CryptlexWebApiClientOptions` 即兴表演.

```ts
import { CryptlexWebApiClient, CryptlexWebApiClientOptions } from "@cryptlex/web-api-client";

const ACCESS_TOKEN = "**ACCESS_TOKEN**";
const PRODUCT_ID = "**PRODUCT_ID**";

const clientOptions = new CryptlexWebApiClientOptions(ACCESS_TOKEN);
const client = new CryptlexWebApiClient(clientOptions);

try {
  // Create a license in the product defined by PRODUCT_ID
  const licenseResponse = await client.createLicense({ productId: PRODUCT_ID });
  console.log("Successfully created license: " + JSON.stringify(licenseResponse.data));
} catch (error) {
  console.error(error);
}
```

# 职能

这个图书馆的范围可见于 [完整的函数列表](https://github.com/cryptlex/web-api-client-js/blob/main/docs/functions.md) 可用.

## 常见问题

### @cryptlex/web-api-client 是什么？

Cryptlex Web API 客户端库

### 如何安装 @cryptlex/web-api-client？

在项目目录运行 npm install @cryptlex/web-api-client，或使用 pnpm add / yarn add / bun add。

### @cryptlex/web-api-client 支持 TypeScript 吗？

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

### @cryptlex/web-api-client 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cryptlex/web-api-client 需要什么版本的 Node\.js？

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

### @cryptlex/web-api-client 可以商用吗？

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

### @cryptlex/web-api-client 的下载量有多少？

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

### @cryptlex/web-api-client 还在维护吗？

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