Points (REST)

Endpoint

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

Test Server : https://test1-api.vixco.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

Points are issued

post

Authorizations

bearer-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Token name

Body

application/json

tokenAmountstringOptional

Token amount

tidstringOptional

Store TID

Responses

200

Points issued successfully

application/json

post

/points/{name}/issue

HTTPcURLJavaScriptPython

POST /v1/points/{name}/issue HTTP/1.1
Host: test1-api.vixco.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "tokenAmount": "text",
  "tid": "text"
}

200

Points issued successfully

{
  "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

Accumulate

The issued points are accumulated to the user wallet address

post

Authorizations

bearer-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Token name

rewardIdstringRequired

Reward ID

Body

application/json

tokenAmountstringOptional

Token amount

userAddressstringOptional

User wallet address to accumulate

Responses

200

Points are accumulated successfully

application/json

post

/points/{name}/{rewardId}/accumulate

HTTPcURLJavaScriptPython

POST /v1/points/{name}/{rewardId}/accumulate HTTP/1.1
Host: test1-api.vixco.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

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

200

Points are accumulated successfully

{
  "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

Status

Check if it has been accumulated

get

Authorizations

bearer-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Token name

rewardIdstringRequired

Reward ID

Responses

200

Return successfully

application/json

get

/points/{name}/{rewardId}/status

HTTPcURLJavaScriptPython

GET /v1/points/{name}/{rewardId}/status HTTP/1.1
Host: test1-api.vixco.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Return successfully

{
  "userAddress": "text",
  "accumulated": true,
  "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

Cancel

Cancel the issued points

post

Authorizations

bearer-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Token name

rewardIdstringRequired

Reward ID

Body

application/json

tokenAmountstringOptional

Token amount

Responses

200

Canceled successfully

application/json

post

/points/{name}/{rewardId}/cancel

HTTPcURLJavaScriptPython

POST /v1/points/{name}/{rewardId}/cancel HTTP/1.1
Host: test1-api.vixco.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "tokenAmount": "text"
}

200

Canceled successfully

{
  "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

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