登录到 ACDD

/login

Method : POST
URL : https://xxx.finexusgroup.com/acdd/rest/v1/login

信息

这种方法允许提交一个请求，要求使用由主机签名的加密消息来获取一个 apiKey 以便登录 ACDD 系统。

请求

请求参数

字段名	是否必需	类型	长度	描述	示例
sourceInfo	是	对象		源信息。	参阅下文说明
interactionMode	是	对象		交互模式。	参阅下文说明
language	可选	字符串	2	语言。	"en"
contextInfo	是	对象		上下文信息。	参阅下文说明

对象：sourceInfo

字段名	是否必需	类型	长度	描述	示例
source	是	字符串	16	源。	"FNXCRDS"
partnerID	是	字符串	128	合作伙伴 ID。	"BSSS"
productType	是	字符串	128	产品类型。	"loanapplication"
reference	是	字符串	64	参考。	"50074154501001"
apiVersion	是	字符串	8	API 版本。	"1.2"
apiKey	可选	字符串	64	API 密钥。	"123KEJRU001"
userId	可选	字符串	32	用户 ID。	"u125"
userToken	可选	字符串	64	用户令牌。	"Cb1sci18j2UvNLsq4"

对象：interactionMode

字段名	是否必需	类型	长度	描述	示例
mode	是	字符串	8	模式。	"SYNC","ASYNC"
callbackUrl	可选	字符串	256	回调 URL。	"www.google.com"

对象：contextInfo

字段名	是否必需	类型	长度	描述	示例
licenseKey	是	字符串		许可密钥。	"ASJ123412"
ctxDateTime	是	对象		请求日期和时间。	"2203161000699"
purpose	是	字符串	16	调用目的。	"Test"
ctxSourceInfo	是	对象	16	上下文源信息。	参阅下文说明
signature	是	字符串	16	签名加密消息。	"^X{45}%"

对象：ctxSourceInfo

字段名	是否必需	类型	长度	描述	示例
source	是	字符串	16	源系统。	"MXX"
partnerId	是	字符串	128	客户代码。	"BSSS"

响应

响应代码

响应代码	描述	响应模式
200	允许	CDDPostResponse
400	错误请求	N/A
401	未经授权的访问	N/A
405	禁止访问	N/A

响应参数

字段名称	是否必需	类型	长度	描述	示例
status	是	对象		状态。	参阅下文说明
payload	可选	对象		登录响应。	参阅下文说明

对象: status

字段名称	是否必需	类型	长度	描述	示例
sourceInfo	是	对象		来源信息。	参阅下文说明
errorlist	是	对象		错误列表。	参阅下文说明
status	是	字符串	16	状态。	"SUCCESS","QUEUED","FAIL"

对象: payload

字段名称	是否必需	类型	长度	描述	示例
apiKey	是	字符串	64	API 密钥。	"123KEJRU001"

对象: sourceInfo

字段名称	是否必需	类型	长度	描述	示例
source	是	字符串	16	来源。	"FNXCRDS"
partnerID	是	字符串	128	合作伙伴ID。	"BSSS"
productType	是	字符串	128	产品类型。	"loanapplication"
reference	是	字符串	64	参考。	"50074154501001"
apiVersion	是	字符串	8	API 版本。	"1.2"
apiKey	可选	字符串	64	API 密钥。	"123KEJRU001"
userId	可选	字符串	32	用户ID。	"u125"
userToken	可选	字符串	64	用户令牌。	"Cb1sci18j2UvNLsq4"

对象: errorList

字段名称	是否必需	类型	长度	描述	示例
msgText	是	字符串	128	消息文本。	"Login unsuccessful."
msgCode	是	字符串	8	消息代码。	"404"

示例消息

请求

/login POST 请求

{
   "sourceInfo": {
      "source": "test",
      "partnerId": "test",
      "apiVersion": "1.3",
      "reference": "e19342b2e6074364bb51af270db71fa6Vc38TdFyPHcCEqg9",
      "productType": "testing"
   },
   "interactionMode": {
      "mode": "async"
   },
   "contextInfo": {
      "licenseKey": "ASJ123412",
      "ctxDateTime": "20211201083010",
      "purpose": "Test",
      "ctxSourceInfo": {
         "source": "FNXCRDS",
         "partnerId": "PR"
         },
         "signature": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      }
}

响应

/login POST 响应

{   
"status": {
        "sourceInfo": {
            "source": "test",
            "partnerId": "test",
            "apiVersion": "1.3",
            "reference": "e19342b2e6074364bb51af270db71fa6V9",
            "productType": "testing"
        },
        "errorList": [
                {
                       "msgText": "",
                       "msgCode": ""
                }
            ],
        "status": "SUCCESS"
    },
    "payload": {
        "apiKey": "1F4ABF0D68F49A43A21C6C5F163CAB5"
    }
}