Ctrlk
HomeGitHubReferenceLanguage
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Customer/Social

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
thirdSourcestringOptional

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

Responses
200Success
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
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"
}
200Success
{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "thirdSource": "text",
    "clientId": "text",
    "developerAccount": "text"
  }
}

Apple Third-party Login Verification

post

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

Body
companyIdintegerRequired
openIdstringOptional

Required on app end

identityTokenstringOptional

Required on app end

emailintegerOptional
codestringOptional

Required on web end

idTokenstringOptional

Required on web end

Responses
200Success
application/json
codestringRequired

0-Success, other exceptions

msgstringRequired
bizCodestringRequired
tmintegerRequired
tracestringRequired
msgParamsstringRequired
post/h/com.cats.customer.api.app.CustomerThirdLoginService/appleVerify
POST /api/h/com.cats.customer.api.app.CustomerThirdLoginService/appleVerify HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "companyId": 1,
  "openId": "text",
  "identityToken": "text",
  "email": 1,
  "code": "text",
  "idToken": "text"
}
200Success
{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "userId": "text",
    "action": "text",
    "result": true,
    "failReason": "text",
    "thirdSource": "text",
    "email": "text",
    "phone": "text"
  }
}

Facebook Third-party Login Verification

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.facebookVerify Access after login

Body
accessTokenstringOptional

Verify accessToken

Responses
200Success
application/json
codestringRequired

0-Success, other exceptions

msgstringRequired
bizCodestringRequired
tmintegerRequired
tracestringRequired
msgParamsstringRequired
post/third/login/customer.app.CustomerThirdLoginService.facebookVerify
POST /api/third/login/customer.app.CustomerThirdLoginService.facebookVerify HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 22

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

Google Third-party Login Verification

post

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

Body
idTokenstringOptional
accessTokenstringOptional
Responses
200Success
application/json
codestringRequired

0-Success, other exceptions

msgstringRequired
bizCodestringRequired
tmintegerRequired
tracestringRequired
msgParamsstringRequired
post/h/com.cats.customer.api.app.CustomerThirdLoginService/googleVerify
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"
}
200Success
{
  "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"
}

Telegram third-party login verification

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.telegramVerify ###Version 0.0.2, used for third-party registration and login (no need for phone or email) version=0.0.2 bizType=customer.app.CustomerThirdLoginService.telegramVerify Access after login

Header parameters
companyIdstringRequiredExample: {{company}}
langstringRequiredExample: en-US
tracestringRequiredExample: {{mock_trace}}
versionstringRequiredExample: 0.0.1
Body
userJsonStrstringRequired
channelSourcestringRequired
Responses
200Success
application/json
codestringRequired

0-Success, other exceptions

msgstringRequired

Return information

bizCodestringRequired

Module identifier code

tmintegerRequired

Processing time (milliseconds)

tracestringRequired

Global link flag information

msgParamsstringRequired

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

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

{
  "userJsonStr": "text",
  "channelSource": "text"
}
200Success
{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "userId": "text",
    "action": "text",
    "result": true,
    "failReason": "text",
    "thirdSource": "text",
    "email": "text",
    "phone": "text",
    "authToken": "text"
  }
}

Metamask third-party login verification

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.metaMaskVerify Access after login

Body
web3SignaturestringRequired
addressstringRequired
timestampintegerRequired
Responses
200Success
application/json
codestringRequired

0-Success, other exceptions

msgstringRequired
bizCodestringRequired
tmintegerRequired
tracestringRequired
msgParamsstringRequired
post/third/login/customer.app.CustomerThirdLoginService.metaMaskVerify
POST /api/third/login/customer.app.CustomerThirdLoginService.metaMaskVerify HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "web3Signature": "text",
  "address": "text",
  "timestamp": 1
}
200Success
{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "userId": "text",
    "action": "text",
    "result": true,
    "failReason": "text",
    "thirdSource": "text",
    "email": "text",
    "phone": "text"
  }
}

Twitter third-party login verification

post

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

Body
oauth_tokenstringRequired

oauth_token

oauth_token_secretstringRequired

oauth_token_secret

user_idstringRequired

user_id

screen_namestringRequired

screen_name

access_tokenstringRequired

access_token

statestringRequired

state

client_idstringRequired

client_id

networkstringRequired

network

displaystringRequired

display

redirect_uristringRequired

redirect_uri

scopestringRequired

scope

oauth_proxystringRequired

oauth_proxy

Responses
200Success
application/json
codestringRequired

0-Success, other exceptions

msgstringRequired
bizCodestringRequired
tmintegerRequired
tracestringRequired
msgParamsstringRequired
post/third/login/customer.app.CustomerThirdLoginService.twitterVerify
POST /api/third/login/customer.app.CustomerThirdLoginService.twitterVerify HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "oauth_token": "text",
  "oauth_token_secret": "text",
  "user_id": "text",
  "screen_name": "text",
  "access_token": "text",
  "state": "text",
  "client_id": "text",
  "network": "text",
  "display": "text",
  "redirect_uri": "text",
  "scope": "text",
  "oauth_proxy": "text"
}
200Success
{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "userId": "text",
    "action": "text",
    "result": true,
    "failReason": "text",
    "thirdSource": "text",
    "email": "text",
    "phone": "text"
  }
}

Third-party login

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.login Accessible to guests

Header parameters
companyIdstringRequiredExample: {{company}}
langstringRequiredExample: en-US
tracestringRequiredExample: {{mock_trace}}
versionstringRequiredExample: 0.0.1
Body
thirdSourcestringRequired

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

userIdstringRequired

Third-party userId

emailstringRequired

Email

phonestringRequired

Phone Number

Responses
200Success
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/third/login/customer.app.CustomerThirdLoginService.login
POST /api/third/login/customer.app.CustomerThirdLoginService.login HTTP/1.1
Host: prewppc-3.cmfbl.com
companyId: text
lang: text
trace: text
version: text
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "thirdSource": "text",
  "userId": "text",
  "email": "text",
  "phone": "text"
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "id": 1,
    "companyId": 1,
    "customerGroupId": 1,
    "customerNo": "text",
    "kycAuditStatus": 1,
    "kycAuditRemark": "text",
    "kycStatus": 1,
    "kycRemark": "text",
    "accountList": {},
    "accountRemark": "text",
    "loginPassStatus": "text",
    "payPassStatus": "text",
    "email": "text",
    "phone": "text",
    "phoneArea": "text",
    "name": "text",
    "country": "text",
    "type": 1,
    "deposit": 1,
    "withdraw": 1,
    "optional": 1,
    "activateStatus": 1,
    "activateTime": 1,
    "companyKycStatus": 1,
    "status": 1,
    "thirdServerCode": "text",
    "source": "text",
    "thirdLoginSource": "text",
    "thirdUserId": "text",
    "idCard": "text",
    "idCardType": "text",
    "thirdIntactMsg": "text",
    "firstName": "text",
    "lastName": "text",
    "isFund": 1,
    "assertPassStatus": "text",
    "googleId": 1,
    "openAccountType": 1,
    "loginTime": 1,
    "createTime": 1,
    "relationCustomerId": 1,
    "companyType": "text",
    "registerSource": 1,
    "associationCompanyId": 1,
    "registerTime": 1
  },
  "ok": true,
  "fail": true
}

Third-party login (no need for phone, email)

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.socialLogin Guest access

Header parameters
companyIdstringRequiredExample: {{company}}
langstringRequiredExample: en-US
tracestringRequiredExample: {{mock_trace}}
versionstringRequiredExample: 0.0.1
Body
thirdSourcestringRequired

Third-party source telegram

userIdstringRequired

Third-party userId

authTokenstring · min: 64 · max: 64Required

Third-party authorization certificate

Responses
200Success
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/third/login/customer.app.CustomerThirdLoginService.socialLogin
POST /api/third/login/customer.app.CustomerThirdLoginService.socialLogin HTTP/1.1
Host: prewppc-3.cmfbl.com
companyId: text
lang: text
trace: text
version: text
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "thirdSource": "text",
  "userId": "text",
  "authToken": "text"
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "id": 1,
    "companyId": 1,
    "customerGroupId": 1,
    "customerNo": "text",
    "kycAuditStatus": 1,
    "kycAuditRemark": "text",
    "kycStatus": 1,
    "kycRemark": "text",
    "accountList": {},
    "accountRemark": "text",
    "loginPassStatus": "text",
    "payPassStatus": "text",
    "email": "text",
    "phone": "text",
    "phoneArea": "text",
    "name": "text",
    "country": "text",
    "type": 1,
    "deposit": 1,
    "withdraw": 1,
    "optional": 1,
    "activateStatus": 1,
    "activateTime": 1,
    "companyKycStatus": 1,
    "status": 1,
    "thirdServerCode": "text",
    "source": "text",
    "thirdLoginSource": "text",
    "thirdUserId": "text",
    "idCard": "text",
    "idCardType": "text",
    "thirdIntactMsg": "text",
    "firstName": "text",
    "lastName": "text",
    "isFund": 1,
    "assertPassStatus": "text",
    "googleId": 1,
    "openAccountType": 1,
    "loginTime": 1,
    "createTime": 1,
    "relationCustomerId": 1,
    "companyType": "text",
    "registerSource": 1,
    "associationCompanyId": 1,
    "registerTime": 1
  },
  "ok": true,
  "fail": true
}

Third-party registration

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.register Guest access

Header parameters
companyIdstringOptionalExample: {{company}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
countrystringRequired

Country

thirdSourcestringOptional

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

userIdstringOptional

Third-party userId

customerGroupIdinteger · int64Optional

Client group ID

emailstringOptional

Email and phone number must exist one

phonestringOptional

Phone Number

phoneAreastringOptional

New phone area code

verifyCodestringOptional

Verification code

sendTokenstringOptional

Verification code sending ticket

registerSourceinteger · int32 · min: 1Optional

Registration source: 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=other

utmSourcestringOptional

Advertising source (account opening link parameter source)

utmMediumstringOptional

Advertising medium (account opening link parameter medium)

utmCampaignstringOptional

Advertising campaign (account opening link parameter campaign)

utmContentstringOptional

Advertising group (account opening link parameter content)

utmTermstringOptional

Keyword (account opening link parameter term)

langstringOptional

Language Information

thirdServerCodestring · max: 45Optional

Unique identifier from third-party system

thirdServerSourcestring · max: 10Optional

Third-party system source, such as: agent=agent

registerDevicestringOptional

Registered device model

Responses
200Success
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/third/login/customer.app.CustomerThirdLoginService.register
POST /api/third/login/customer.app.CustomerThirdLoginService.register HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "customerGroupId": 1,
  "userId": "5708954114",
  "phoneArea": "18163223782",
  "phone": "18631358776",
  "sendToken": "reprehenderit veniam do sit minim",
  "verifyCode": "23",
  "country": "CN",
  "thirdSource": "telegram",
  "registerSource": 2,
  "thirdServerSource": "test",
  "thirdServerCode": "10"
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "customerNo": "text",
    "list": [
      {
        "levelCode": "text",
        "openAccountType": 1,
        "levelName": "text",
        "pathName": "text",
        "pathCode": "text",
        "elementList": [
          {
            "elementCode": "text",
            "elementName": "text",
            "showType": "text",
            "extend": "text",
            "elementValue": "text",
            "elementValueInputGroup": "text",
            "elementCodeInputGroup": "text"
          }
        ]
      }
    ],
    "companyId": 1,
    "ext1": "text",
    "ext2": "text",
    "email": "text",
    "phone": "text",
    "phoneArea": "text",
    "name": "text",
    "loginPassStatus": "text",
    "payPassStatus": "text",
    "customerGroupId": 1,
    "country": "text",
    "id": 1,
    "optional": 1,
    "companyKycStatus": 1,
    "thirdServerCode": "text",
    "source": "text",
    "capitalInStatus": 1,
    "openAccountType": 1,
    "companyType": "text",
    "associationCompanyId": 1,
    "registerTime": 1,
    "apiCheckSwitch": true,
    "apiCheckRule": "text",
    "token": "text"
  },
  "ok": true,
  "fail": true
}

Third-party registration (no need for phone, email)

post

version=0.0.1 bizType=customer.app.CustomerThirdLoginService.socialRegister Accessible for guests

Header parameters
companyIdstringOptionalExample: {{company}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
countrystringRequired

Country code

thirdSourcestringRequired

Third-party source telegram

userIdstringRequired

Third-party userId

authTokenstring · min: 64 · max: 64Required

Third-party authorization certificate

registerSourceinteger · int32 · min: 1Required

Registration source: 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=other

customerGroupIdinteger · int64Optional

Client group ID

utmSourcestringOptional

Advertising source (account opening link parameter source)

utmMediumstringOptional

Advertising medium (account opening link parameter medium)

utmCampaignstringOptional

Advertising campaign (account opening link parameter campaign)

utmContentstringOptional

Advertising group (account opening link parameter content)

utmTermstringOptional

Keyword (account opening link parameter term)

langstringOptional

Language Information

thirdServerCodestring · max: 45Optional

Unique identifier from third-party system

thirdServerSourcestring · max: 10Optional

Third-party system source, such as: agent=agent

registerDevicestringOptional

Registered device model

tokenstringOptional

Login Token

Responses
200Success
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/third/login/customer.app.CustomerThirdLoginService.socialRegister
POST /api/third/login/customer.app.CustomerThirdLoginService.socialRegister HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "country": "text",
  "thirdSource": "text",
  "userId": "text",
  "authToken": "text",
  "registerSource": 1,
  "customerGroupId": 1,
  "utmSource": "text",
  "utmMedium": "text",
  "utmCampaign": "text",
  "utmContent": "text",
  "utmTerm": "text",
  "lang": "text",
  "thirdServerCode": "text",
  "thirdServerSource": "text",
  "registerDevice": "text",
  "token": "text"
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "customerNo": "text",
    "list": [
      {
        "levelCode": "text",
        "openAccountType": 1,
        "levelName": "text",
        "pathName": "text",
        "pathCode": "text",
        "elementList": [
          {
            "elementCode": "text",
            "elementName": "text",
            "showType": "text",
            "extend": "text",
            "elementValue": "text",
            "elementValueInputGroup": "text",
            "elementCodeInputGroup": "text"
          }
        ]
      }
    ],
    "companyId": 1,
    "ext1": "text",
    "ext2": "text",
    "email": "text",
    "phone": "text",
    "phoneArea": "text",
    "name": "text",
    "loginPassStatus": "text",
    "payPassStatus": "text",
    "customerGroupId": 1,
    "country": "text",
    "id": 1,
    "optional": 1,
    "companyKycStatus": 1,
    "thirdServerCode": "text",
    "source": "text",
    "capitalInStatus": 1,
    "openAccountType": 1,
    "companyType": "text",
    "associationCompanyId": 1,
    "registerTime": 1,
    "apiCheckSwitch": true,
    "apiCheckRule": "text"
  },
  "ok": true,
  "fail": true
}
PreviousCustomer/BasicNextCustomer/Auth

Last updated