@yunzhanghu/sdk-nodejs 1.0.0 → 1.0.1

package/README.md

@@ -1,7 +1,7 @@
 # 云账户 SDK for Node.js
 
 欢迎使用云账户 SDK for Node.js。  
-云账户是一家专注为平台企业和新就业形态劳动者提供高质量灵活就业服务的新时代企业。云账户 SDK 对云账户综合服务平台 API 接口进行封装，让您不必担心过多参数请求，帮助您快速接入到云账户综合服务平台。云账户 SDK for Node.js 为您提供签约、下单、回调、数据查询等功能，帮助您完成与云账户综合服务平台的接口对接及业务开发。  
+云账户是一家专注为平台企业和新就业形态劳动者提供高质量灵活就业服务的新时代企业。云账户 SDK 对云账户综合服务平台 API 接口进行封装，帮助您快速接入到云账户综合服务平台。云账户 SDK for Node.js 为您提供签约、支付、回调、数据查询等功能，帮助您完成与云账户综合服务平台的接口对接及业务开发。  
 如果您在使用过程中遇到任何问题，请在当前 GitHub 提交 Issues，或发送邮件至技术支持组 [techsupport@yunzhanghu.com](mailto:techsupport@yunzhanghu.com)。
 
 ## 环境要求
@@ -12,7 +12,7 @@
 
 ### 1、获取配置
 
-使用云账户 SDK for Node.js 前，您需先获取 dealer_id、broker_id、3DES Key、App Key 信息。  
+使用云账户 SDK for Node.js 前，您需先获取 dealer_id、broker_id、3DES Key、App Key、云账户公钥。  
 获取方式：使用开户邮件中的账号登录【[云账户综合服务平台](https://service.yunzhanghu.com)】，选择“业务中心 > 业务管理 > 对接信息”，查看并获取以上配置信息。
 ![获取配置信息](https://yos.yunzhanghu.com/getobject/duijiexinxi.png?isAttachment=false&fileID=9487bd54b93a5abf49003c2b8ce7e069bfa24220&signature=X%2BR7PocQgPqSpR2xM1TgYU6lAapr%2FB9p3aFof03Gcfw%3D)
 
@@ -34,37 +34,37 @@ OpenSSL-> rsa -in private_key.pem -pubout -out pubkey.pem
 
 - 方式二：使用工具生成
 
-请联系云账户技术支持获取 RSA 密钥生成工具 > 登录【[云账户开放平台](https://open.yunzhanghu.com/)】，选择“开发工具下载 > 开发助手 > 工具下载”，下载安装“云账户开放平台开发助手”
+登录【[云账户开放平台](https://open.yunzhanghu.com)】，选择“开发工具下载 > 开发助手 > 工具下载”，下载安装“云账户开放平台开发助手”。
 
 ### 3、配置密钥
 
 登录【[云账户综合服务平台](https://service.yunzhanghu.com)】，选择“业务中心 > 业务管理 > 对接信息”，单击页面右上角的“编辑”，配置平台企业公钥。  
 ![配置平台企业公钥信息](https://yos.yunzhanghu.com/getobject/dujiexinxi-2.png?isAttachment=false&fileID=84e3cd1684a61c1e32eb0e7b7f43390cd053206b&signature=mqW8Zbk7h3gYXfzjR99pK%2B0pgVLcLly3VjBB2KsqDvQ%3D)
 
-## 安装 Node.js SDK
+## 安装云账户 SDK for Node.js
 
 ### 通过 NPM 安装
 
-推荐通过 Node.js 的包管理工具 NPM 获取并安装 Node.js SDK。NPM 详细介绍请参考[ NPM 官网](https://www.npmjs.com/) 。
+推荐通过 Node.js 的包管理工具 NPM 获取并安装云账户 SDK for Node.js。NPM 详细介绍请参考[ NPM 官网](https://www.npmjs.com) 。
 
-1. 执行以下安装命令安装云账户 Node.js SDK：
+1. 执行以下安装命令安装云账户 SDK for Node.js：
 
    > npm install @yunzhanghu/sdk-nodejs --save
 
-2. 在您的代码中引用对应模块代码，可参考示例。
+2. 在您的代码中引用对应模块代码，具体引用方式可参考下文示例。
 
 ### 通过源码包安装
 
 1. 前往 [Github 仓库](https://github.com/YunzhanghuOpen/sdk-nodejs) 下载源码压缩包；
 2. 解压源码包到您项目的合适位置；
-3. 在您的代码中引用对应模块代码，可参考示例。
+3. 在您的代码中引用对应模块代码，具体引用方式可参考下文示例。
 
 ## 快速使用
 
 ### 示例功能列表
 
-- [用户信息验证](./example/verify.js)
-- [H5 签约](./example/h5UserSign.js) or [API 签约](./example/apiUserSign.js)
+- [用户信息验证](./example/authentication.js)
+- [用户签约（H5 签约）](./example/h5UserSign.js) or [用户签约（API 签约）](./example/apiUserSign.js)
 - [个体工商户注册（云账户新经济 H5）](./example/bizlicXjjH5.js) or [个体工商户注册（云账户新经济 H5+API）](./example/bizlicXjjH5Api.js)
 - [实时支付](./example/payment.js)
 - [异步通知](./example/notify.js)
@@ -104,8 +104,8 @@ client
   .GetInvoiceAmount({
     dealer_id: process.env.DEALER_ID,
     broker_id: process.env.BROKER_ID,
-//  可自定义 Header 中的 request-id，建议将 request-id 记录在日志中
-//  request_id:'req1678257009001'
+// 可自定义 Header 中的 request-id，建议将 request-id 记录在日志中
+// request_id:'req1678257009001'
   })
   .then((data) => {
     console.log("data", data)

package/example/apiUserSign.js

@@ -1,13 +1,13 @@
 const yzhAPI = require("../yzh/index.js")
 const config = require("./conf/config.js")
 
-// API 签约
+// 用户签约（API 签约）
 
 const apiusersign = new yzhAPI.ApiUserSignServiceClient(config)
 
 // 获取协议预览 URL
 apiusersign
-  .ApiUseSignContract({
+  .ApiUserSignContract({
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
   })

package/example/h5UserSign.js

@@ -1,7 +1,7 @@
 const yzhAPI = require("../yzh/index.js")
 const config = require("./conf/config.js")
 
-// H5 签约
+// 用户签约（H5 签约）
 
 const h5usersign = new yzhAPI.H5UserSignServiceClient(config)
 

package/example/invoice.js

@@ -89,3 +89,16 @@ invoice
   .catch((err) => {
     console.log(err.toString())
   })
+
+// 查询发票信息
+invoice
+  .GetInvoiceInformation({
+    invoice_apply_id: "",
+    application_id: "423721",
+  })
+  .then((data) => {
+    console.log('响应内容: %j', data)
+  })
+  .catch((err) => {
+    console.log(err.toString())
+  })

package/example/notify.js

@@ -1,6 +1,6 @@
 const yunzhanghu = require("../yzh/index.js")
 
-// 模拟异步通知接口验签+解密
+// 异步通知
 
 const util = new yunzhanghu.Util({
   dealer_id: process.env.DEALER_ID,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yunzhanghu/sdk-nodejs",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "云账户 SDK for Node.js",
   "main": "yzh/index.js",
   "scripts": {

package/src/common/client.ts

@@ -130,7 +130,7 @@ export class YZHClient {
 
       const data = this.encrypt(plaintext)
 
-      const signStr = this.generatorSign(data, m, t)
+      const signStr = this.sign(data, m, t)
       return {
         data,
         mess: m,
@@ -150,7 +150,7 @@ export class YZHClient {
    * @param {string} timestamp 时间戳，精确到秒
    * @returns {string} 签名内容
    */
-  private generatorSignRSASHA256 = (data: string, mess: string, timestamp: string) => {
+  private signRSASHA256 = (data: string, mess: string, timestamp: string) => {
     try {
       const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`
       const sign = crypto.createSign("RSA-SHA256")
@@ -169,7 +169,7 @@ export class YZHClient {
    * @param {string} timestamp 时间戳，精确到秒
    * @returns {string} 签名内容
    */
-  private generatorSignHmacSHA256 = (data: string, mess: string, timestamp: string) => {
+  private signHmacSHA256 = (data: string, mess: string, timestamp: string) => {
     try {
       const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`
       const hmac = crypto.createHmac("sha256", this.app_key)
@@ -188,14 +188,14 @@ export class YZHClient {
    * @param {string} sign_type 签名方式
    * @returns {string} 签名内容
    */
-  private generatorSign = (data: string, mess: string, timestamp: string) => {
+  private sign = (data: string, mess: string, timestamp: string) => {
     try {
       switch (this.sign_type) {
         case "rsa": {
-          return this.generatorSignRSASHA256(data, mess, timestamp)
+          return this.signRSASHA256(data, mess, timestamp)
         }
         case "sha256": {
-          return this.generatorSignHmacSHA256(data, mess, timestamp)
+          return this.signHmacSHA256(data, mess, timestamp)
         }
         default:
           throw new YZHSDKHttpException(`sign_type类型不存在`)
@@ -239,12 +239,12 @@ export class YZHClient {
       yzhError.httpCode = result.status
       throw yzhError
     } else {
-      // httpcode 200
+      // HTTP Status Code 200
       const { data: axiosData } = result
       let response = axiosData
       // 需解密
       if (encryption) {
-        response = { ...response, data: this.decryption(response.data) }
+        response = { ...response, data: this.decrypt(response.data) }
       }
       return response
     }
@@ -255,7 +255,7 @@ export class YZHClient {
    * @param ciphertext
    * @returns 明文数据
    */
-  decryption = (ciphertext: string) => {
+  decrypt = (ciphertext: string) => {
     try {
       const iv = this.des3_key.slice(0, 8)
       const cipherChunks = []
@@ -350,7 +350,7 @@ export class YZHClient {
       const verifyResult = verifyMap[this.sign_type](data, mess, timestamp, sign)
       let plaintext = {}
       if (verifyResult) {
-        plaintext = this.decryption(data)
+        plaintext = this.decrypt(data)
       }
       return {
         result: verifyResult,

package/src/services/apiusersign/index.ts

@@ -16,6 +16,22 @@ interface ApiUseSignContractResponse {
   title: string
 }
 
+/** ApiUserSignContractRequest 获取协议预览 URL 请求 V2 */
+interface ApiUserSignContractRequest {
+  /** 平台企业 ID */
+  dealer_id: string
+  /** 综合服务主体 ID */
+  broker_id: string
+}
+
+/** ApiUserSignContractResponse 获取协议预览 URL 返回 V2 */
+interface ApiUserSignContractResponse {
+  /** 预览跳转 URL */
+  url: string
+  /** 协议名称 */
+  title: string
+}
+
 /** ApiUserSignRequest 用户签约请求 */
 interface ApiUserSignRequest {
   /** 综合服务主体 ID */
@@ -98,6 +114,14 @@ export class ApiUserSignServiceClient extends YZHclient {
     return this.request("get", "/api/sign/v1/user/contract", req, { encryption: false }, cb)
   }
 
+  // ApiUserSignContract 获取协议预览 URL V2
+  async ApiUserSignContract(
+    req: ApiUserSignContractRequest,
+    cb?: (error: null | string, rep: ApiUserSignContractResponse) => void
+  ): Promise<ApiUserSignContractResponse> {
+    return this.request("get", "/api/sign/v1/user/contract", req, { encryption: false }, cb)
+  }
+
   // ApiUserSign 用户签约
   async ApiUserSign(
     req: ApiUserSignRequest,

package/src/services/invoice/index.ts

@@ -284,7 +284,7 @@ export class InvoiceClient extends YZHclient {
   ): Promise<GetInvoiceInformationResponse> {
     return this.request(
       "post",
-      "/api/invoice/v2/invoice-information",
+      "/api/invoice/v2/invoice-face-information",
       req,
       { encryption: false },
       cb

package/yzh/common/client.d.ts

@@ -47,7 +47,7 @@ export declare class YZHClient {
      * @param {string} timestamp 时间戳，精确到秒
      * @returns {string} 签名内容
      */
-    private generatorSignRSASHA256;
+    private signRSASHA256;
     /**
      * 生成签名（HmacSHA256）
      * @param {string} data 经过加密后的具体数据
@@ -55,7 +55,7 @@ export declare class YZHClient {
      * @param {string} timestamp 时间戳，精确到秒
      * @returns {string} 签名内容
      */
-    private generatorSignHmacSHA256;
+    private signHmacSHA256;
     /**
      * 生成签名
      * @param {string} data 经过加密后的具体数据
@@ -64,7 +64,7 @@ export declare class YZHClient {
      * @param {string} sign_type 签名方式
      * @returns {string} 签名内容
      */
-    private generatorSign;
+    private sign;
     private mess;
     /**
      * 3DES 加密数据
@@ -78,7 +78,7 @@ export declare class YZHClient {
      * @param ciphertext
      * @returns 明文数据
      */
-    decryption: (ciphertext: string) => any;
+    decrypt: (ciphertext: string) => any;
     /**
      * 验签
      * @param {string} data 返回的数据

package/yzh/common/client.js

@@ -26,7 +26,7 @@ class YZHClient {
          * @param {string} timestamp 时间戳，精确到秒
          * @returns {string} 签名内容
          */
-        this.generatorSignRSASHA256 = (data, mess, timestamp) => {
+        this.signRSASHA256 = (data, mess, timestamp) => {
             try {
                 const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`;
                 const sign = crypto.createSign("RSA-SHA256");
@@ -45,7 +45,7 @@ class YZHClient {
          * @param {string} timestamp 时间戳，精确到秒
          * @returns {string} 签名内容
          */
-        this.generatorSignHmacSHA256 = (data, mess, timestamp) => {
+        this.signHmacSHA256 = (data, mess, timestamp) => {
             try {
                 const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`;
                 const hmac = crypto.createHmac("sha256", this.app_key);
@@ -64,17 +64,17 @@ class YZHClient {
          * @param {string} sign_type 签名方式
          * @returns {string} 签名内容
          */
-        this.generatorSign = (data, mess, timestamp) => {
+        this.sign = (data, mess, timestamp) => {
             try {
                 switch (this.sign_type) {
                     case "rsa": {
-                        return this.generatorSignRSASHA256(data, mess, timestamp);
+                        return this.signRSASHA256(data, mess, timestamp);
                     }
                     case "sha256": {
-                        return this.generatorSignHmacSHA256(data, mess, timestamp);
+                        return this.signHmacSHA256(data, mess, timestamp);
                     }
                     default:
-                        throw new yzhSDKHttpException_1.default(`sign_type类型不存在`);
+                        throw new yzhSDKHttpException_1.default(`sign_type 类型不存在`);
                 }
             }
             catch (err) {
@@ -111,7 +111,7 @@ class YZHClient {
          * @param ciphertext
          * @returns 明文数据
          */
-        this.decryption = (ciphertext) => {
+        this.decrypt = (ciphertext) => {
             try {
                 const iv = this.des3_key.slice(0, 8);
                 const cipherChunks = [];
@@ -188,7 +188,7 @@ class YZHClient {
                 const verifyResult = verifyMap[this.sign_type](data, mess, timestamp, sign);
                 let plaintext = {};
                 if (verifyResult) {
-                    plaintext = this.decryption(data);
+                    plaintext = this.decrypt(data);
                 }
                 return {
                     result: verifyResult,
@@ -278,7 +278,7 @@ class YZHClient {
             const m = this.mess();
             const plaintext = JSON.stringify(params);
             const data = this.encrypt(plaintext);
-            const signStr = this.generatorSign(data, m, t);
+            const signStr = this.sign(data, m, t);
             return {
                 data,
                 mess: m,
@@ -299,12 +299,12 @@ class YZHClient {
             throw yzhError;
         }
         else {
-            // httpcode 200
+            // HTTP Status Code 200
             const { data: axiosData } = result;
             let response = axiosData;
             // 需解密
             if (encryption) {
-                response = { ...response, data: this.decryption(response.data) };
+                response = { ...response, data: this.decrypt(response.data) };
             }
             return response;
         }

package/yzh/services/apiusersign/index.d.ts

@@ -13,6 +13,20 @@ interface ApiUseSignContractResponse {
     /** 协议名称 */
     title: string;
 }
+/** ApiUserSignContractRequest 获取协议预览 URL 请求 V2 */
+interface ApiUserSignContractRequest {
+    /** 平台企业 ID */
+    dealer_id: string;
+    /** 综合服务主体 ID */
+    broker_id: string;
+}
+/** ApiUserSignContractResponse 获取协议预览 URL 返回 V2 */
+interface ApiUserSignContractResponse {
+    /** 预览跳转 URL */
+    url: string;
+    /** 协议名称 */
+    title: string;
+}
 /** ApiUserSignRequest 用户签约请求 */
 interface ApiUserSignRequest {
     /** 综合服务主体 ID */
@@ -79,6 +93,7 @@ export declare class ApiUserSignServiceClient extends YZHclient {
         base_url?: string;
     });
     ApiUseSignContract(req: ApiUseSignContractRequest, cb?: (error: null | string, rep: ApiUseSignContractResponse) => void): Promise<ApiUseSignContractResponse>;
+    ApiUserSignContract(req: ApiUserSignContractRequest, cb?: (error: null | string, rep: ApiUserSignContractResponse) => void): Promise<ApiUserSignContractResponse>;
     ApiUserSign(req: ApiUserSignRequest, cb?: (error: null | string, rep: ApiUserSignResponse) => void): Promise<ApiUserSignResponse>;
     GetApiUserSignStatus(req: GetApiUserSignStatusRequest, cb?: (error: null | string, rep: GetApiUserSignStatusResponse) => void): Promise<GetApiUserSignStatusResponse>;
     ApiUserSignRelease(req: ApiUserSignReleaseRequest, cb?: (error: null | string, rep: ApiUserSignReleaseResponse) => void): Promise<ApiUserSignReleaseResponse>;

package/yzh/services/apiusersign/index.js

@@ -10,6 +10,10 @@ class ApiUserSignServiceClient extends client_1.default {
     async ApiUseSignContract(req, cb) {
         return this.request("get", "/api/sign/v1/user/contract", req, { encryption: false }, cb);
     }
+    // ApiUserSignContract 获取协议预览 URL V2
+    async ApiUserSignContract(req, cb) {
+        return this.request("get", "/api/sign/v1/user/contract", req, { encryption: false }, cb);
+    }
     // ApiUserSign 用户签约
     async ApiUserSign(req, cb) {
         return this.request("post", "/api/sign/v1/user/sign", req, { encryption: false }, cb);

package/yzh/services/invoice/index.js

@@ -24,7 +24,7 @@ class InvoiceClient extends client_1.default {
     }
     // GetInvoiceInformation 查询发票信息
     async GetInvoiceInformation(req, cb) {
-        return this.request("post", "/api/invoice/v2/invoice-information", req, { encryption: false }, cb);
+        return this.request("post", "/api/invoice/v2/invoice-face-information", req, { encryption: false }, cb);
     }
     // GetInvoiceFile 下载 PDF 版发票
     async GetInvoiceFile(req, cb) {