Login

Rainbow-APIs is based on JWT. In order to use the open APIs, login APIs provide us entries to get the JWT.

Login actions

Login actions provide users the entries to call the open APIs including Metadata, Mints, Contract, Files.

App Login

APP login API helps users to get the JWT according to app_id and app_secret. JWT can be used to access other open APIs.

App login

post

Login the app to get the JWT according to the app_id and app_secret

Body

app_idstringRequired

app_secretstringRequired

Responses

application/json

objectOptional

application/json

post

HTTPcURLJavaScriptPython

POST /v1/login HTTP/1.1
Host: api.nftrainbow.cn
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "app_id": "text",
  "app_secret": "text"
}

{
  "expire": "text",
  "token": "text"
}

Parameters

Name	Meaning	Param Type	Data Type	Required
app_id	The id of the app	body	string
app_secret	The secret of the app	body	string

Parameter Example

{
    "app_id": "qUUcdueA",
    "app_secret": "zGCaP8kAFEmwanqo"
}

Response

The returned result can be used to access other OPEN-APIs

Name	Meaning	Type
token	JWT token	String
expire	The expired time	String

Response Example

{
    "expire": "2022-08-31T15:54:04.2046805+08:00",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NjE5MzI0NDQsImlkIjozLCJvcmlnX2lhdCI6MTY1OTM0MDQ0NH0.BLkzyiQzxlljYLj5Gjjqjnd4fFm1GdoEduaVrVlU_Tw"
}

Request Sample

curl --request POST \
  --url https://api.nftrainbow.cn/v1/login \
  --header 'Content-Type: application/json' \
  --data-raw `{
    "app_id": "qUUcdueA",
    "app_secret": "zGCaP8kAFEmwanqo"
}`

Note: Each JWT is valid to call open APIs for one hour. Once the JWT is expired, users have to call Refresh JWT to get the new JWT.

Refresh JWT

Refresh JWT API helps users to get a new JWT of the specified app.

Refresh JWT

get

Obtain a new JWT

Header parameters

AuthorizationanyRequired

Bearer openapi_token

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /v1/refresh_token HTTP/1.1
Host: api.nftrainbow.cn
Accept: */*

{
  "expire": "text",
  "token": "text"
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Response

Name	Meaning	Type
token	JWT token	String
expire	The expired time	String

Response Example

{
    "expire": "2022-08-31T15:54:04.2046805+08:00",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NjE5MzI0NDQsImlkIjozLCJvcmlnX2lhdCI6MTY1OTM0MDQ0NH0.BLkzyiQzxlljYLj5Gjjqjnd4fFm1GdoEduaVrVlU_Tw"
}

Request Sample

curl --request GET \
  --url https://api.nftrainbow.cn/v1/refresh_token \
  --header 'Authorization: Bearer {JWT}' \
  --header 'Content-Type: application/json'

Note: Each JWT is valid to call Refresh JWT for five hours. Once the JWT is expired, users have to call App Login to get JWT agian.