登录到 AIV

/aivlogin

Method : POST
URL : https://xxx.finexusgroup.com/AIV/rest/v1/aivlogin

信息

• 该方法允许从 eKYC 的 web 应用提交一个请求，以获取通过主机签署的加密消息来登录到 AIV 系统的 apiKey。
• licenseKey 将由 Finexus 提供

请求

请求参数

字段名称	必填	类型	长度	描述	示例
sourceInfo	是	对象		来源信息	参阅下文说明
interactionMode	是	对象		交互模式	参阅下文说明
contextInfo	是	对象		上下文信息	参阅下文说明

对象：sourceInfo

字段名称	必填	类型	长度	描述	示例
source	是	字符串	16	来源	"FNXCRDS"
partnerId	是	字符串	128	合作伙伴ID	"BSSS"
productType	可选	字符串	128	合作伙伴类型	"appTest"
reference	是	字符串	64	引用	"ID00000213132"
apiVersion	是	字符串	8	API版本	"1.6"
apiKey	有条件	字符串	64	API密钥	"1233214HSC"
userId	可选	字符串	32	用户ID	"mkchan"
userToken	可选	字符串	64	用户令牌	"APPOKJSID8J1234"

对象：interactionMode

字段名称	必填	类型	长度	描述	示例
mode	是	字符串	8	模式	"ASYNC"
callbackUrl	可选	字符串	256	回调URL

对象：contextInfo

字段名	必填	类型	描述	示例
ctxSourceInfo	是	对象	上下文源信息。	参阅下文说明。
licenseKey	是	字符串	许可密钥。	"ASJ123412"
ctxDateTime	是	字符串	上下文日期时间。	"2203161000699"
purpose	是	字符串	目的。	"Test"
signature	是	字符串	签名。	"4C3ACE806CD5F"

对象：ctxSourceInfo

字段名	必填	类型	描述	示例
source	是	字符串	源。	"FNXCRDS"
partnerId	是	字符串	合作伙伴ID。	"BSSS"

响应

响应代码	描述	响应模式
200	该服务能够验证并允许调用者使用服务和方法。	AIVLoginResponse
400	请求错误，服务无法按预期找到消息布局。	NIL
401	未经授权的访问 - 无法验证源系统。	NIL
405	禁止访问 - 源系统未被授权执行操作。	NIL

响应参数

字段名称	必填	类型	长度	描述	示例
status	是	对象		状态。	参阅下文说明。
payload	可选	对象		AIV 登录信息。	参阅下文说明。

对象：status

字段名	必填	类型	描述	示例
sourceInfo	是	对象	源信息。	参阅下文说明。
errorList	是	数组对象	错误列表。	参阅下文说明。
status	是	字符串	状态。	"SUCCESS"

对象：sourceInfo

字段名	必填	类型	描述	示例
source	是	字符串	源。	"FNXCRDS"
partnerId	是	字符串	合作伙伴ID。	"BSSS"
productType	可选	字符串	合作伙伴类型。	"appTest"
reference	是	字符串	参考。	"2003160192931"
apiVersion	是	字符串	API版本。	"1.6"
apiKey	有条件	字符串	API密钥。	"123-KEJRU-001"
userId	可选	字符串	用户ID。	"mkchan"
userToken	可选	字符串	用户令牌。	"APPOKJSID8J1234"

对象：errorList

字段名	必填	类型	描述	示例
msgCode	是	字符串	消息代码。	"000"
msgText	是	字符串	消息文本。

对象：payload

字段名	必填	类型	描述	示例
apiKey	是	字符串	API密钥。	"1233214HSC"

示例消息

请求

/aivlogin POST 请求

curl -X POST "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivlogin" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 
 -d '{
        "sourceInfo": {
            "source": "test",
            "partnerId": "test",
            "apiVersion": "1.6",
            "reference": "e19342b2e6074364bb51af270db71fa6Vc38TdFyPHcCEqg9",
        },
        "interactionMode": {
            "mode": "async"
        },
        "contextInfo": {
            "licenseKey": "ASJ123412",
            "ctxDateTime": "20211201083010",
            "purpose": "Test",
            "ctxSourceInfo": {
                "source": "FNXCRDS",
                "partnerId": "PR"
            },
            "signature": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        }
    }'

响应

/aivlogin POST 响应

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