Points (REST)

Endpoint

Real Server : https://api.finenex.net/v1

Test Server : https://test1-api.finenex.net/v1

Authentication

To make a request, you need to include the JWT in the HTTP header. JWT can be received through the authentication server.

Example

If JWT is "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NDgyMDc1OTIsImlhdCI6MTY0ODEyMTE5Mn0.AYNcBLhKqtqwzxNm7kOREEUH0_3gFevOXxI94TBORao",

curl -X 'POST' \
  '{endpoint}/nlp/issue' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NDgyMDc1OTIsImlhdCI6MTY0ODEyMTE5Mn0.AYNcBLhKqtqwzxNm7kOREEUH0_3gFevOXxI94TBORao' \
  -H 'Content-Type: application/json' \
  -d '{
  "tokenAmount": "10"
}'

API References

Issue

NLP or NURI points are issued

POSThttps://test1-api.finenex.net/v1/points/{name}/issue

Authorization

bearer-key

Path parameters

name*string

Token name (nlp or nuri)

Body

application/json

tokenAmountstring

Token amount

tidstring

Store TID

Response

200

Points issued successfully

Body

application/json

rewardIdstring

Reward ID

tokenSymbolstring

Token symbol (NLP or NURI)

tokenAmountstring

Token amount

contractAddressstring

Contract address for token

rewardDatestring

Issued Date, for example, 20220325151440+0900

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/points/{name}/issue', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "rewardId": "text",
  "tokenSymbol": "text",
  "tokenAmount": "text",
  "contractAddress": "text",
  "rewardDate": "text"
}

If tranNo, amount, and the token name of recently issued points are the same, it is treated as a duplicate issuance and is failed.

Example

Reqeust

curl -X 'POST' \
  '{endpoint}/points/nlp/issue' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNzgxNTgsImlhdCI6MTY1MjE5MTc1OH0.MqMd26110LlpuVrY-17so_WJ0icVlom0iqbp_0dVo58' \
  -H 'Content-Type: application/json' \
  -d '{
  "tokenAmount": "10",
  "tid": "test01"
}'

Response

{
  "rewardId": "6500627A723D0000",
  "tokenSymbol": "NLP",
  "tokenAmount": "10",
  "contractAddress": "0x31a093de11a38d00ec33f112cac623afb1ae9276",
  "rewardDate": "20220510231005+0900"
}

Accumulate

The issued points are accumulated to the user wallet address

POSThttps://test1-api.finenex.net/v1/points/{name}/{rewardId}/accumulate

Authorization

bearer-key

Path parameters

name*string

Token name (nlp or nuri)

rewardId*string

Reward ID

Body

application/json

tokenAmountstring

Token amount

userAddressstring

User wallet address to accumulate

Response

200

Points are accumulated successfully

Body

application/json

userAddressstring

User wallet address to accumulate

tokenSymbolstring

Token symbol (NLP or NURI)

tokenAmountstring

Token amount

contractAddressstring

Contract address for token

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/points/{name}/{rewardId}/accumulate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "userAddress": "text",
  "tokenSymbol": "text",
  "tokenAmount": "text",
  "contractAddress": "text"
}

Example

Request

curl -X 'POST' \
  '{endpoint}/points/nlp/6500627A723D0000/accumulate' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNzgxNTgsImlhdCI6MTY1MjE5MTc1OH0.MqMd26110LlpuVrY-17so_WJ0icVlom0iqbp_0dVo58' \
  -H 'Content-Type: application/json' \
  -d '{
  "tokenAmount": "10",
  "userAddress": "user-address"
}'

Response

{
  "userAddress": "user-address",
  "tokenSymbol": "NLP",
  "tokenAmount": "10.00",
  "contractAddress": "0x31a093de11a38d00ec33f112cac623afb1ae9276"
}

Status

Check if it has been accumulated

GEThttps://test1-api.finenex.net/v1/points/{name}/{rewardId}/status

Authorization

bearer-key

Path parameters

name*string

Token name (nlp or nuri)

rewardId*string

Reward ID

Response

200

Return successfully

Body

application/json

userAddressstring

User wallet address if accumulated, otherwise null

accumulatedboolean

Is points accumulated

tokenSymbolstring

Token symbol (NLP or NURI)

contractAddressstring

Contract address for token

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/points/{name}/{rewardId}/status', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "userAddress": "text",
  "accumulated": false,
  "tokenSymbol": "text",
  "contractAddress": "text"
}

Example

Request

curl -X 'GET' \
  '{endpoint}/points/nlp/6500627A723D0000/status' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNzgxNTgsImlhdCI6MTY1MjE5MTc1OH0.MqMd26110LlpuVrY-17so_WJ0icVlom0iqbp_0dVo58'

Response

{
  "userAddress": "user-address",
  "accumulated": true,
  "tokenSymbol": "NLP",
  "contractAddress": "0x31a093de11a38d00ec33f112cac623afb1ae9276"
}

Cancel

Cancel the issued points

POSThttps://test1-api.finenex.net/v1/points/{name}/{rewardId}/cancel

Authorization

bearer-key

Path parameters

name*string

Token name (nlp or nuri)

rewardId*string

Reward ID

Body

application/json

tokenAmountstring

Token amount

Response

200

Canceled successfully

Body

application/json

userAddressstring

User wallet address or null

tokenSymbolstring

Token symbol

tokenAmountstring

Token amount

contractAddressstring

Contract address for token

Request

JavaScriptCurlPython

const response = await fetch('https://test1-api.finenex.net/v1/points/{name}/{rewardId}/cancel', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "userAddress": "text",
  "tokenSymbol": "text",
  "tokenAmount": "text",
  "contractAddress": "text"
}

Example

Request

curl -X 'POST' \
  '{endpoint}/points/nlp/6500627A723D0000/cancel' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MTExQGRzdGEuY29tIiwicm9sZSI6IlJPTEVfU1RPUkUiLCJleHAiOjE2NTIyNzgxNTgsImlhdCI6MTY1MjE5MTc1OH0.MqMd26110LlpuVrY-17so_WJ0icVlom0iqbp_0dVo58' \
  -H 'Content-Type: application/json' \
  -d '{
  "tokenAmount": "10"
}'

Response

{
  "userAddress": "user-address",
  "tokenSymbol": "NLP",
  "tokenAmount": "10",
  "contractAddress": "0x31a093de11a38d00ec33f112cac623afb1ae9276"
}

The token amount should be the same as when the points are issued.

Error Codes (resCode)

• 200: Success

• 400: Bad parameters

• 401: Unauthenticated

• 404: Not found

• 500: Internal server error. Please see resMessage