# @adobe/spacecat-shared-ims-client 中文文档

规范地址：https://npmcn.com/package/%40adobe/spacecat-shared-ims-client/

版本：1\.16\.0
npm 元数据更新时间：2026-10-01T01:35:18.177Z
中文译文更新时间：2026-11-06T16:25:30.835Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：125 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0 \<25\.0\.0
- 运行依赖：5 个
- 首次发布：2024-02-16T14:08:53.470Z
- 最新版本发布：2026-08-12T09:31:43.760Z
- 近 30 天下载量：2750（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：107（近 12 个月 32 个）

## 中文简介

Spacecat 服务的共享模块 - IMS客户端

## 安装

```sh
npm install @adobe/spacecat-shared-ims-client
```

也可以使用：`pnpm add @adobe/spacecat-shared-ims-client`、`yarn add @adobe/spacecat-shared-ims-client`、`bun add @adobe/spacecat-shared-ims-client`

## README

# Spacecat 共享 - IMS 客户端

## 概览

ImsClient库旨在与IMS(身份管理系统)API进行互动,为检索组织细节,用户信息,服务访问符提供方便. 本文件概述了建立环境的必要步骤,并为将ImsClient纳入您的项目提供了使用实例.

## 环境设置

在使用 ImsClient 之前,请确保您的环境配置正确,并附有必要的证书和终点 。 需要以下环境变量:

-   `IMS_HOST`: IMS API的主机名.
-   `IMS_CLIENT_ID`:你的IMS客户端ID.
-   `IMS_CLIENT_CODE`:您的IMS客户端代码,用于认证.
-   `IMS_CLIENT_SECRET`:您的IMS客户端秘密,用于认证.

## 安装

将 ImsClient 从源文件导入到您的项目中 。 确保依赖性,例如: `@adobe/fetch` 财务报告和审定财务报表 `@adobe/spacecat-shared-utils` 也安装在您的工程中.

```javascript
import ImsClient from 'path/to/ImsClient';
```

## 使用量

### 创建无效实例

要创建 ImsClient 实例, 您需要提供包含必要的环境配置和可选日志的上下文对象 .

```javascript
const context = {
  env: {
    IMS_HOST: 'ims.example.com',
    IMS_CLIENT_ID: 'yourClientId',
    IMS_CLIENT_CODE: 'yourClientCode',
    IMS_CLIENT_SECRET: 'yourClientSecret',
  },
  log: console, // Optional: Custom log can be provided
};

const imsClient = ImsClient.createFrom(context);
```

### 获取服务访问托肯

要获取服务访问符, 请使用 `getServiceAccessToken` 方法。 认证随后的API请求需要这个符号.

```javascript
async function fetchServiceAccessToken() {
  try {
    const token = await imsClient.getServiceAccessToken();
    console.log('Service Access Token:', token);
  } catch (error) {
    console.error('Error fetching service access token:', error);
  }
}

fetchServiceAccessToken();
```

### 获取 IMS 组织细节

使用国际监测系统的身份证获取关于该组织的详细情况 `getImsOrganizationDetails` 方法.

```javascript
async function fetchImsOrganizationDetails(imsOrgId) {
  try {
    const details = await imsClient.getImsOrganizationDetails(imsOrgId);
    console.log('Organization Details:', details);
  } catch (error) {
    console.error('Error fetching organization details:', error);
  }
}

const imsOrgId = 'yourImsOrgId';
fetchImsOrganizationDetails(imsOrgId);
```

## 处理错误

所有的方法都回报承诺。 使用 `try/catch` 对话框,用于管理 API 的 ASync 函数中,优雅地请求失败或无效的响应.

## 发展

### 测试

进行测试:

```bash
npm test
```

### 线性

打开密码 :

```bash
npm run lint
```

### 清理

要删除 `node_modules` 财务报告和审定财务报表 `package-lock.json`数字 :

```bash
npm run clean
```

## 补充资料

-   **仓库**数字 : [GitHub 图像](https://github.com/adobe/spacecat-shared.git)
-   **问题跟踪**数字 : [GitHub 问题](https://github.com/adobe/spacecat-shared/issues)
-   **许可证**: Apache-2.0 数据

## 常见问题

### @adobe/spacecat-shared-ims-client 是什么？

Spacecat 服务的共享模块 - IMS客户端

### 如何安装 @adobe/spacecat-shared-ims-client？

在项目目录运行 npm install @adobe/spacecat-shared-ims-client，或使用 pnpm add / yarn add / bun add。

### @adobe/spacecat-shared-ims-client 支持 TypeScript 吗？

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

### @adobe/spacecat-shared-ims-client 支持 ESM 还是 CommonJS？

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

### @adobe/spacecat-shared-ims-client 需要什么版本的 Node\.js？

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

### @adobe/spacecat-shared-ims-client 可以商用吗？

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

### @adobe/spacecat-shared-ims-client 的下载量有多少？

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

### @adobe/spacecat-shared-ims-client 还在维护吗？

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