# @arrowsphere/api-client 中文文档

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

版本：3\.422\.0
npm 元数据更新时间：2026-11-12T08:41:13.873Z
中文译文更新时间：2026-11-12T08:43:34.386Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：2 MB，770 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2021-02-15T15:18:39.009Z
- 最新版本发布：2026-11-12T08:41:13.129Z
- 近 30 天下载量：5095（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：1017（近 12 个月 196 个）

## 中文简介

ArrowSphere 公共 API 的节点客户端

## 安装

```sh
npm install @arrowsphere/api-client
```

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

## README

# ArrowSphere 节点js- api 客户端软件包

[![npm version](https://badgen.net/npm/v/@arrowsphere/api-client)](https://www.npmjs.com/package/@arrowsphere/api-client) [![node version](https://badgen.net/badge/node/%3E=%2012.21.0/green?icon=terminal)](https://badgen.net/badge/node/%3E=%2012.21.0/green?icon=terminal) [![Lint, Build, Test](https://github.com/ArrowSphere/nodejs-api-client/workflows/Lint,%20Build,%20Test/badge.svg)](https://github.com/ArrowSphere/nodejs-api-client/actions?query=workflow%3A%22Lint%2C+Build%2C+Test%22) [![Coverage Status](https://coveralls.io/repos/github/ArrowSphere/nodejs-api-client/badge.svg?branch=main)](https://coveralls.io/github/ArrowSphere/nodejs-api-client?branch=main)

这个软件包为ArrowSphere的公用API提供了一个Node.js HTTP客户端. 它应该是给ArrowSphere的API打电话的唯一方法,带有Node.js代码.

要使用此软件包,您需要有效访问ArrowSphere,并带有有效的API密钥.

# 安全免责声明

**请在安装新依赖时保持极端谨慎 。 在添加到您的项目之前, 总是要验证任何库的来源和声誉, 以避免引入恶意包 .**

## 安装

安装最新版本

```bash
npm install @arrowsphere/api-client
```

## 基本用途

```js
const { PublicApiClient } = require('@arrowsphere/api-client')

const URL = 'https://your-url-to-arrowsphere.example.com'
const API_KEY = 'your API key in ArrowSphere'

const client = new PublicApiClient().setUrl(URL).setApiKey(API_KEY)

client
  .getWhoamiClient()
  .getWhoami()
  .then((result) => console.log(result))
```

## 类型文件

生成 [类型文件](https://typedoc.org/) 文档并探索,使用以下命令

```shell
npm run doc
```

产出文件应位于 `docs/` 文件夹,只需在任何本地浏览器中打开索引.html文件.

## 特定API客户端

### 常规

-   [检查域](https://npmcn.com/package/%40arrowsphere/api-client/src/general/CHECKDOMAIN.md)
    
-   [谁啊](https://npmcn.com/package/%40arrowsphere/api-client/src/general/WHOAMI.md)
    
-   [运动](https://npmcn.com/package/%40arrowsphere/api-client/src/campaign/README.md)
    
-   [圆筒](https://npmcn.com/package/%40arrowsphere/api-client/src/cart/README.md)
    
-   [目录](https://npmcn.com/package/%40arrowsphere/api-client/src/catalog/README.md)
    
-   [消费](https://npmcn.com/package/%40arrowsphere/api-client/src/consumption/README.md)
    
-   [联系人](https://npmcn.com/package/%40arrowsphere/api-client/src/contact/README.md)
    
-   [客户](https://npmcn.com/package/%40arrowsphere/api-client/src/customers/README.md)
    
-   [许可证](https://npmcn.com/package/%40arrowsphere/api-client/src/licenses/README.md)
    
-   [命令](https://npmcn.com/package/%40arrowsphere/api-client/src/orders/README.md)
    
-   [订阅](https://npmcn.com/package/%40arrowsphere/api-client/src/subscriptions/README.md)
    
-   [支助中心](https://npmcn.com/package/%40arrowsphere/api-client/src/supportCenter/README.md)
    
-   [安全分数](https://npmcn.com/package/%40arrowsphere/api-client/src/securityScore/README.md)
    

### 许可证

-   查找 [许可证](https://npmcn.com/package/%40arrowsphere/api-client/src/licenses/README.md#LicenseFind)
-   获取 [许可证](https://npmcn.com/package/%40arrowsphere/api-client/src/licenses/README.md#LicenseGet)

## 常见问题

### @arrowsphere/api-client 是什么？

ArrowSphere 公共 API 的节点客户端

### 如何安装 @arrowsphere/api-client？

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

### @arrowsphere/api-client 支持 TypeScript 吗？

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

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

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

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

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

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

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

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