# @flexbase/ecredit-node-client 中文文档

规范地址：https://npmcn.com/package/%40flexbase/ecredit-node-client/

版本：0\.15\.0
npm 元数据更新时间：2025-08-10T12:20:14.594Z
中文译文更新时间：2026-11-14T22:26:18.657Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：82.7 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12\.\*
- 运行依赖：7 个
- 首次发布：2022-07-19T10:45:18.660Z
- 最新版本发布：2023-08-27T12:19:25.619Z
- 近 30 天下载量：104004（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

CRS 信用eCredit API 的 CRS 客户端

## 安装

```sh
npm install @flexbase/ecredit-node-client
```

也可以使用：`pnpm add @flexbase/ecredit-node-client`、`yarn add @flexbase/ecredit-node-client`、`bun add @flexbase/ecredit-node-client`

## README

# 电子信用节点客户端

`ecredit-node-client` 是节点/ JS 和 TypeScript 客户端 [CRS 信贷](https://crscreditapi.com/) 允许您使用普通节点 语法到Experian, Equifax, 以及来自 CRS Credit 的其他数据 [电子编辑 API](https://crscreditapi.com/signup-smart-api/)。 。 。 .

## 安装

```bash
# with npm
$ npm install @flexbase/ecredit-node-client
```

## 使用量

这研究不会涵盖CRS信用的所有细节, 和如何使用它 - 它的目标作为一个 _伴侣_ 给 CRS 信用开发商 [文档](https://crsecreditdataapi.redoc.ly/) 解释每个终点和一般CRS信贷方式 [API 密码](https://crsecreditdataapi.redoc.ly/) 工作时.

不过,我们会举出很多例子 这样就可以清楚如何使用这个 库与 CRS Credit 交互.

### 获取您的全权证书

此客户端使用标准 `username` 财务报告和审定财务报表 `password`,你得到这些 来自CRS信用支持团队.

### 创建客户端

目前,有针对性地提供一组职能 客户端。 目前这些是关于Experian域名的. 随着我们增加更多的特征, 这个客户会大吃一惊的 但现在,我们需要它来做这个.

客户的基本构造是:

```typescript
import { Ecredit } from '@flexbase/ecredit-node-client'
const client = new Ecredit(username, password)
```

如果你想提供主机 用于,比如,沙盒访问, 这也可以在构造器中提供:

```typescript
const client = new Eclient(username, password, {
  host: 'mware-dev.crscreditapi.com/api',
})
```

备选办法可包括:

-   `host` - 发送所有eCredit呼叫的主机名

### 过期电话

CRS 信用 API [文档](https://crsecreditdataapi.redoc.ly/) 被拆分为 不同科室,对于Exemerian科,我们已经执行 对我们的工作最重要的呼声.

#### [基本信用报告](https://crsecreditdataapi.redoc.ly/tag/Experian#operation/creditReportBasic_1)

您可以获得一个基本的 Experiorian 信用报告 单调:

```typescript
const resp = await client.experian.basic({
  firstName: 'ANDERSON',
  lastName: 'LAURIE',
  ssn: '666-45-5730',
  street1: '9817 LOOP BLVD',
  street2: 'APT G',
  city: 'CALIFORNIA CITY',
  state: 'CA',
  zip: '93505-1352',
})
```

其中用户是Experian sandbox实例的测试用户. 还有 反应方式如下:

```javascript
{
  success: true,
  report: {
    headerRecord: [ [Object] ],
    addressInformation: [ [Object], [Object], [Object] ],
    consumerIdentity: { dob: [Object], name: [Array] },
    employmentInformation: [ [Object], [Object] ],
    informationalMessage: [ [Object], [Object] ],
    inquiry: [ [Object], [Object], [Object] ],
    publicRecord: [ [Object] ],
    riskModel: [ [Object] ],
    tradeline: [
      [Object], [Object],
      [Object], [Object],
      [Object], [Object],
      [Object], [Object],
      [Object], [Object],
      [Object], [Object],
      [Object], [Object],
      [Object], [Object],
      [Object]
    ],
    endTotals: [ [Object] ]
  }
}
```

在 Typescript 中包含完整、详细的结构 `interface` 定义.

有一个 _选项_ 配置,详见CRS信贷文件,以及 可指定为:

```typescript
const resp = await client.experian.basic(person, {
  config: 'exp-prequal-vantage4',
})
```

这将是 _版本_ 从Experian上提取的报告 然后回到了CRS Credit, 并最终,客户.

## 发展

对于那些有兴趣在图书馆工作的人来说,有些事情是 工作会简单一点 代码的组织全部在 `src/`,每个模块 _节_ 用户名: `authentication`, (中文(简体) ), `experian`等 (中文(简体) ). 这使得函数的位置非常容易.

此外,与CRS信贷服务的主要联系是: `src/index.ts` 模块 `fire()` 函数。 在构造器中 客户,每个 _节次_ 被创建,然后链接到 他们的交流工作主课.

### 设置

为了与守则合作,发展依赖包括: `dotenv` 以便每个用户都能创建 `.env` 具有单一工作值的文件 cRS 信贷:

-   `ECREDIT_USERNAME` - 这是CRS信用生成的"用户名".
-   `ECREDIT_PASSWORD` - 这是CRS的"密码".

### 测试

有几个测试脚本可以测试和验证关于 CRS信贷服务行使API的不同部分. 每个都是 自成一体,并可使用:

```bash
$ npm run ts tests/basic.ts

> @flexbase/ecredit-node-client@0.1.0 ts
> ts-node -r dotenv/config "tests/basic.ts"

doing a soft pull from Experian...
Success! Pulled the prequal report for test person
doing a hard pull from Experian...
Success! Pulled the hard report for test person
```

每次测试都会通过客户端进行一系列的通话,然后检查 结果显示操作成功。 如所示,如果所有步骤 报告内容 `Success!` 然后一切正常进行.

如果有一个电话有问题,那么 `Error!` 将打印 ,从客户端返回的数据将被丢弃到控制台.

## 常见问题

### @flexbase/ecredit-node-client 是什么？

CRS 信用eCredit API 的 CRS 客户端

### 如何安装 @flexbase/ecredit-node-client？

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

### @flexbase/ecredit-node-client 支持 TypeScript 吗？

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

### @flexbase/ecredit-node-client 支持 ESM 还是 CommonJS？

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

### @flexbase/ecredit-node-client 需要什么版本的 Node\.js？

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

### @flexbase/ecredit-node-client 可以商用吗？

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

### @flexbase/ecredit-node-client 的下载量有多少？

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

### @flexbase/ecredit-node-client 还在维护吗？

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