电子信用节点客户端
ecredit-node-client 是节点/ JS 和 TypeScript 客户端
CRS 信贷 允许您使用普通节点
语法到Experian, Equifax, 以及来自 CRS Credit 的其他数据
电子编辑 API。 。 。 .
安装
# with npm
$ npm install @flexbase/ecredit-node-client
使用量
这研究不会涵盖CRS信用的所有细节, 和如何使用它 - 它的目标作为一个 伴侣 给 CRS 信用开发商 文档 解释每个终点和一般CRS信贷方式 API 密码 工作时.
不过,我们会举出很多例子 这样就可以清楚如何使用这个 库与 CRS Credit 交互.
获取您的全权证书
此客户端使用标准 username 财务报告和审定财务报表 password,你得到这些
来自CRS信用支持团队.
创建客户端
目前,有针对性地提供一组职能 客户端。 目前这些是关于Experian域名的. 随着我们增加更多的特征, 这个客户会大吃一惊的 但现在,我们需要它来做这个.
客户的基本构造是:
import { Ecredit } from '@flexbase/ecredit-node-client'
const client = new Ecredit(username, password)
如果你想提供主机 用于,比如,沙盒访问, 这也可以在构造器中提供:
const client = new Eclient(username, password, {
host: 'mware-dev.crscreditapi.com/api',
})
备选办法可包括:
host- 发送所有eCredit呼叫的主机名
过期电话
CRS 信用 API 文档 被拆分为 不同科室,对于Exemerian科,我们已经执行 对我们的工作最重要的呼声.
基本信用报告
您可以获得一个基本的 Experiorian 信用报告 单调:
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实例的测试用户. 还有 反应方式如下:
{
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信贷文件,以及 可指定为:
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的不同部分. 每个都是 自成一体,并可使用:
$ npm run ts tests/basic.ts
> @flexbase/[email protected] 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! 将打印
,从客户端返回的数据将被丢弃到控制台.