Login

Trading client login authorization

Introduction

This interface is used to log in to the trading system when customizing the client, and to subscribe to quotes and place trading orders.

Interface

Email/Mobile phone number login

Login

post

version=0.0.1 bizType=customer.app.CustomerWebApiService.login Guest Accessible

Header parameters

versionstringRequired

Version Number

Example: 0.0.1

companyIdstringRequired

Company ID, obtained through environment variables

Example: {{company}}

tracestringRequired

Random Tracking Code UUID

Example: {{mock_trace}}

langstringRequired

Language

Example: zh-CN

Body

application/json

typeintegerRequired

Registration and Login Methods: 1 Email, 2 Phone Number, 3 Customer Account

phoneAreastringOptional

Phone Area Code; Required field when type is 2: Phone Number

loginNamestringRequired

Account: Email/Phone Number

deviceintegerRequired

Login Device: 1=Mobile Web: H5, 2=PC Web: PC_Web, 3=System & Backend Registration: System, 4=Android Native App: Android, 5=iOS Native App: iOS, 6=HarmonyOS: HOS, 7=PC Windows Client: PC_Win, 8=PC Mac Client: PC_Mac, 9=Others

isThirdbooleanRequired

Is it a third party

verifyCodestringOptional

Verification code

sendTokenstringOptional

Verification code sending ticket

loginPwdstringOptional

Login password

bindThirdUserIdstringOptional

Bind third-party userId

thirdSourcestringOptional

Third-Party Sources: google, facebook, twitter…

googleCodestringOptional

Google Verification Code

Responses

200

Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

msgParamsstringOptional

Placeholder parameter string in return description, multiple parameters separated by commas

okbooleanOptional

failbooleanOptional

post

/login/customer.app.CustomerWebApiService.login

HTTPcURLJavaScriptPython

POST /api/login/customer.app.CustomerWebApiService.login HTTP/1.1
Host: prewppc-3.cmfbl.com
version: text
companyId: text
trace: text
lang: text
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "type": 2,
  "device": 1,
  "loginName": "13429837442",
  "isThird": false,
  "thirdSource": "",
  "bindThirdUserId": "",
  "loginPwd": "dc483e80a7a0bd9ef71d8cf973673924"
}

200

Success

{
  "msg": "Success",
  "fail": false,
  "trace": "x-31z6g86n-kr01ct-4g1u-ci45-1678377046",
  "code": "0",
  "data": {
    "customerGroupId": 1,
    "thirdUserId": null,
    "googleId": -1,
    "lastName": null,
    "country": "CN",
    "kycStatus": 1,
    "companyKycStatus": 2,
    "assertPassStatus": "2",
    "idCard": null,
    "thirdLoginSource": null,
    "payPassStatus": "2",
    "kycAuditRemark": "The company has not enabled KYC certification, go through directly",
    "source": "H5",
    "type": 0,
    "registerSource": 1,
    "loginPassStatus": "2",
    "idCardType": null,
    "loginTime": 1678360534200,
    "kycRemark": "Not verified",
    "associationCompanyId": null,
    "id": 1176,
    "activateStatus": null,
    "email": "22**@qq.com",
    "openAccountType": 0,
    "accountRemark": null,
    "companyType": "real",
    "registerTime": 1648777706117,
    "activateTime": null,
    "kycAuditStatus": 2,
    "optional": 1,
    "isFund": 0,
    "token": "a541f9d5-2507-42b3-b790-59e1f755c380app",
    "firstName": null,
    "companyId": 360,
    "thirdIntactMsg": null,
    "createTime": 1648777706117,
    "phone": "135******9561",
    "relationCustomerId": 0,
    "accountList": [
      {
        "netAssets": "2904318.4696",
        "available": "2904318.4696",
        "remark": null,
        "type": 1,
        "equity": "2904318.4696",
        "firstDepositTime": 1648785031654,
        "lockMargin": "0.0000",
        "balance": "2904321.4696",
        "interest": "0.0000",
        "customerId": 1176,
        "liabilities": "0.0000",
        "currency": "USDT",
        "activateStatus": 2,
        "withdrawAmount": "2904318.4696",
        "profit": "0",
        "tradeType": 5,
        "wholeWarehouseBalance": null,
        "collateralFrozen": "0.0000",
        "freeMargin": "0",
        "margin": "0",
        "firstWithdrawTime": 1648792333492,
        "activateTime": 1648792208194,
        "frozen": "3.0000",
        "wholeWarehouseRate": null,
        "accountId": 1031717,
        "openAccountStatus": true,
        "companyId": 360,
        "liabilitiesPrincipal": "0.0000",
        "interestProportion": null,
        "createTime": 1648777706190,
        "lockAmount": "3.0000",
        "marginRadio": null,
        "notWithdrawAmount": "0.0000",
        "availableLoan": null,
        "digits": 4,
        "customerNo": "86001175",
        "status": 2,
        "assetsId": 13
      }
    ],
    "name": null,
    "phoneArea": "+86",
    "deposit": 1,
    "rToken": "291e08e4e0af86b3d8af85f2947a02125a1c1746db58b303b06cc1aba389f4cd",
    "thirdServerCode": "",
    "customerNo": "86001175",
    "status": 6,
    "withdraw": 1
  },
  "bizCode": "",
  "tm": 82650853,
  "msgParams": null,
  "ok": true
}

Login with social account

Get Third-Party Login Configuration Information

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.config Guest Accessible

Header parameters

versionstringRequiredExample: 0.0.1

companyIdstringRequiredExample: {{company}}

tracestringRequiredExample: {{mock_trace}}

langstringRequiredExample: zh-CN

tokenstringOptionalExample: {{LoginResult.data.token}}

Body

application/json

thirdSourcestringOptional

Third-Party Sources: google, facebook, twitter, telegram, apple, metamask

Responses

200

Success

application/json

codestringRequired

Status Return Code, code=0 indicates current request operation success, other codes handle exceptions

msgstringRequired

Status description

bizCodestringRequired

Module identifier code

tminteger · int64Required

Processing time (milliseconds)

tracestringRequired

Tracking code

msgParamsstringRequired

Placeholder parameter string in return description, multiple parameters separated by commas

post

/global/customer.app.CustomerThirdLoginService.config

HTTPcURLJavaScriptPython

POST /api/global/customer.app.CustomerThirdLoginService.config HTTP/1.1
Host: prewppc-3.cmfbl.com
version: text
companyId: text
trace: text
lang: text
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "thirdSource": "text"
}

200

Success

{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "thirdSource": "text",
    "clientId": "text",
    "developerAccount": "text"
  }
}

Google Third-party Login Verification

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.googleVerify Accessible after login

Body

application/json

idTokenstringOptional

accessTokenstringOptional

Responses

200

Success

application/json

codestringRequired

0-Success, other exceptions

msgstringRequired

bizCodestringRequired

tmintegerRequired

tracestringRequired

msgParamsstringRequired

post

/h/com.cats.customer.api.app.CustomerThirdLoginService/googleVerify

HTTPcURLJavaScriptPython

POST /api/h/com.cats.customer.api.app.CustomerThirdLoginService/googleVerify HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "idToken": "text",
  "accessToken": "text"
}

200

Success

{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 1,
  "trace": "text",
  "data": {
    "thirdSource": "text",
    "result": true,
    "phone": "text",
    "action": "text",
    "failReason": "text",
    "userId": "text",
    "email": "text",
    "token": "text"
  },
  "msgParams": "text"
}