Ingestion API

POST /interfa/v2/auth/token

Returns a JSON object containing the AccessToken and RefreshToken.

Query parameters

Param	Type	Required?	Description
Authorization	String	Required(Header)	Basic Auth
dappid	String	Required	dappid
code	String	Required when grantType is authorization_code	This allows an application to hit APIs on behalf of users. Known as the auth_code. The auth_code has a time limit of 30 seconds once the App owner receives an approved auth_code from the user. You will have to exchange it with an access token within 30 seconds, or the auth_code will expire.
state	String	Optional	state
refreshToken	String	Required when grantType is refresh_token	Allows an dapp to obtain a new access token without prompting the user via the refresh token flow.
grantType	String	Required	The OAuth framework specifies several grant types for different use cases and a framework for creating new grant types. Examples include authorization_code and refresh_token
redirectUrl	String	Required when grantType is authorization_code	Redirect url given to authorization request

Response fields

Param	Type	Description
accessToken	String	Access tokens are the token that applications use to make API requests on behalf of a user.
refreshToken	String	Allows an application to obtain a new access token without prompting the user via the refresh token flow.
expiresIn	Int64	accessToken validity period, unit: seconds
uuid	String	The unique id of the user

Example：

curl -X POST 'https://exdapps.uxlink.io/interfa/v2/auth/token' \
-H 'Authorization: <Basic Auth>' \
-H 'Content-Type: application/json' \
-d '{
  "dappid": "DAPPID",
  "code": "CODE",
  "state": "STATE",
  "grantType": "authorization_code",
  "redirectUrl": "https://dapp.uxlink.io/airdrop2049"
}'

// Response Example:
{
  "success": true,
  "msg": "ok",
  "code": 200,
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1...8btpWyFAI_SI",
    "refreshToken": "eyJhbGciOiJIUzI1NiI...8btpWyFAI_SI",
    "expiresIn": 162341315435,
    "uuid": "177123456789"
  }
}

POST /interfa/v2/user/info

Returns a JSON object providing the user's information, AccountInfo.

Query parameters

Param	Type	Required?	Description
Authorization	String	Required(Header)	Get AccessToken from /interfa/v2/auth/token
uuid	String	Required	The unique id of the user

Response fields

Param	Type	Description
uuid	String	The unique id of the user
name	String	The name of the user
avatar	String	The avatar of the user
socialAddress	String	Represents the abstract address ID related to social accounts, focusing on social identity binding.
chainAddress	String	Represents the abstract address ID of the on-chain account, focusing on blockchain-related interactions.

Example：

curl -X POST 'https://exdapps.uxlink.io/interfa/v2/user/info' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
  "uuid": "177123456789"
}'

// Response Example:
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {
        "uuid": "177123456789",
        "name": "uxlink",
        "avatar": "https://avatar.jpg", 
        "socialAddress": "0xADDRESS", 
        "chainAddress": "0xADDRESS"
    }
}

POST /interfa/v2/user/relation/list

Returns a JSON objects, the user's social relevance.

Query parameters

Param	Type	Required?	Description
Authorization	String	Required(Header)	Get AccessToken from /interfa/v2/auth/token
pageSize	Int	Required	The number of results to be returned per page. This can be a number between 1 and the 500. By default, each page will return 20 results.
nextToken	String	Required	Used to request the next page of results if all results weren't returned with the latest request. It can be null if it is the first page.
uuid	String	Required	The unique id of the user

Response fields

Param	Type	Description
uuid	String	The unique id of the user
name	String	The name of the user
avatar	String	The avatar of the user
socialAddress	String	Represents the abstract address ID related to social accounts, focusing on social identity binding.
chainAddress	String	Represents the abstract address ID of the on-chain account, focusing on blockchain-related interactions.

Example：

curl -X POST 'https://exdapps.uxlink.io/interfa/v2/user/relation/list' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
  "pageSize": 20,
  "nextToken": "1730982011",
  "uuid": "177123456789"
}' 

// Response Example:
{
  "success": true,
  "msg": "ok",
  "code": 200,
  "data": {
    "pageSize": 20,
    "nextPage": true,
    "nextToken": "1730982011",
    "list": [
      {
        "uuid": "12313100000000",
        "name": "ali",
        "avatar": "https://avatar.jpg", 
        "socialAddress": "0xADDRESS", 
        "chainAddress": "0xADDRESS"
      }
    ]
  }
}

POST /interfa/v2/user/wallet/list

Returns a JSON object providing wallet list of user's, include wallet verification.

Query parameters

Param	Type	Required?	Description
Authorization	String	Required(Header)	Get AccessToken from /interfa/v2/auth/token
uuid	String	Required	The unique id of the user

Response fields

Param	Type	Description
uuid	String	The unique id of the user
address	String	Wallet address
walletType	String	Wallet address type: 0 socialAddress 1 metamask, 2 okx 3 coinbase 4 others 5 binance 6 ton wallet
verified	bool	Return true if the wallet address has been signed and verified.

Example：

curl -X POST 'https://exdapps.uxlink.io/interfa/v2/user/wallet/list' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "177123456789"
}'

// Success Response Example:
{
  "success": true,
  "msg": "ok",
  "code": 200,
  "data": {
    "walletList": [
      {
        "uuid": "177123456789",
        "address": "0xADDRESS",
        "walletType": 1,
        "verified": true
      }
    ]
  }
}