Internal project - API Server for admin of IDO platform to manage database
- path: '/api/applied'
- Type: Applied Project
Field | Type | Description |
---|---|---|
Id | Interger |
Project ID |
PersonalName | String |
Project's owner name |
PersonalEmail | String |
Project's owner mail |
PersonalTelegram | String |
Project's onwer telegram |
ProjectName | String |
Project's name |
Description | Text |
short description about project |
Website | String |
Link to project website |
String |
Project's twitter | |
Telegram | String |
Project's telegram |
ChainId | Interger |
Chain of project |
DevelopmentState | String |
state of project development |
Whitepaper | String |
Project's whitepaper |
Tokenomic | String |
Project's tokenomic |
BeforeRaise | Text |
where project has raised before |
TotalRaise | Interger |
Total money project has raised before |
Status | String |
project's status on admin list |
isDeleted | Boolean |
check if project was delete |
Define status field:
| Value | Type | Description |
| NEW | String
| The project has just been created |
| PROCESS | String
| The project is in progress |
| APPROVE | String
| The project has been accepted and the pool is created |
| REFUSE | String
| The project is rejected |
- path: '/applied/all'
Method: GET
Param | Type | Description |
---|---|---|
None | None | None |
Return: All projects are not deletes
- path: '/applied?page=:page&limit=:limit'
Method: GET
Param | Type | Description |
---|---|---|
page | Interger |
current page |
limit | Interger |
Maximum item in 1 page |
Return: all projects that meet the pagination criteria
- path: '/applied/:id'
Method: GET
Param | Type | Description |
---|---|---|
id | Interger |
ID of applied project will be get |
Return: project is not deletes
- path: '/applied/:id/update'
Method: PATCH
Param | Type | Description |
---|---|---|
id | Interger |
ID of applied project will be updated |
Body | Type | Description |
---|---|---|
project | Appiled Project |
project's information to change |
- path: '/applied/:id/delete'
Method: DELETE
Param | Type | Description |
---|---|---|
id | Interger |
ID of applied project will be deleted |
- path: '/applied/create'
Method: POST
Param | Type | Description |
---|---|---|
PersonalName | String |
Project's owner name |
PersonalEmail | String |
Project's owner mail |
PersonalTelegram | String |
Project's onwer telegram |
ProjectName | String |
Project's name |
Description | Text |
short description about project |
Website | String |
Link to project website |
String |
Project's twitter | |
Telegram | String |
Project's telegram |
ChainId | Interger |
Chain of project |
DevelopmentState | String |
state of project development |
Whitepaper | String |
Project's whitepaper |
Tokenomic | String |
Project's tokenomic |
BeforeRaise | Text |
where project has raised before |
TotalRaise | Interger |
Total money project has raised before |
- path: '/applied/development-state'
Method: POST
Param | Type | Description |
---|---|---|
None | None | None |
Body | Type | Description |
---|---|---|
None | None | None |
Return:
Name | Type | Define |
---|---|---|
IDEA | String |
Just an initial idea |
WHITEPAPER | String |
Idea with whitepaper |
DEVELOPMENT | String |
In development |
READY | String |
Ready to launch |
MVP | String |
MVP live |
TESTNET | String |
Testnet |
MAINNET | String |
Mainnet |
- path: '/applied/status'
Method: POST
Param | Type | Description |
---|---|---|
None | None | None |
Body | Type | Description |
---|---|---|
None | None | None |
Return:
Name | Type | Define |
---|---|---|
NEW | String |
new |
PROCESS | String |
process |
APPROVE | String |
approve |
REFUSE | String |
refuse |
- path: '/applied/export'
Method: GET
Return: Datas.xlsx file
- path: '/api/pool'
- Type: Pool
Field | Type | Description |
---|---|---|
Id | String |
Pool ID (yi-1) |
PoolAddress | String |
Pool's pool address |
Name | String |
Pool's name (Yi 1) |
Description | Text |
short description about Pool |
Website | String |
Link to pool website |
Whitepaper | String |
Pool's whitepaper |
String |
Pool's twitter | |
IsPublic | Integer |
Public or private (1: public, 0: private) |
TokenAddress | String |
Pool's token address |
OwnerAddress | String |
Pool's owner address |
LogoUrl | String |
Pool's logo |
BeginTime | Integer |
Pool's begin time |
EndTime | Integer |
Pool's end time |
MoneyRaise | Integer |
Pool's money raise |
ChainId | Interger |
Chain of pool |
- path: '/pool/all'
Method: GET
Param | Type | Description |
---|---|---|
None | None | None |
Body | Type | Description |
---|---|---|
None | None | None |
Return: All pools are in the system
- path: '/pool?page=:page&limit=:limit'
Method: GET
Param | Type | Description |
---|---|---|
page | Interger |
current page |
limit | Interger |
Maximum item in 1 page |
Return: all pools that meet the pagination criteria
- path: '/pool/:id/'
Method: GET
Param | Type | Description |
---|---|---|
id | Interger |
ID of applied project will be deleted |
Body | Type | Description |
---|---|---|
None | None | None |
Return: All details of a pool by Id
- path: '/pool/create'
Method: POST
Param | Type | Description |
---|---|---|
None | None | None |
Body | Type | Description |
---|---|---|
AppliedProjectId | Interger |
ID of applied project will be deployed (used to update the status from "NEW" to "APPROVE") |
PoolAddress | String |
Pool's pool address |
ProjectName | String |
Pool's name |
Description | Text |
short description about Pool |
Website | String |
Link to pool website |
Whitepaper | String |
Pool's whitepaper |
String |
Pool's twitter | |
IsPublic | Integer |
Public or private (1: public, 0: private) |
TokenAddress | String |
Pool's token address |
OwnerAddress | String |
Pool's owner address |
SignerAddress | String |
Pool's signer address |
LogoUrl | String |
Pool's logo |
BeginTime | Integer |
Pool's begin time |
EndTime | Integer |
Pool's end time |
MoneyRaise | Integer |
Pool's money raise |
ChainId | Interger |
Chain of pool |
WhitelistBegin | Integer |
When Whitelist starts |
WhitelistEnd | Interger |
When Whitelist ends |
- path: '/api/user'
- Type: User
Field | Type | Description |
---|---|---|
Id | String |
Pool ID (yi-1) |
Address | String |
User's address |
String |
User's email |
- path: '/user?page=:page&limit=:limit'
Method: GET
Param | Type | Description |
---|---|---|
page | Interger |
current page |
limit | Interger |
Maximum item in 1 page |
Return: all users that meet the pagination criteria
- path: '/user/sendConfirmKYCEmail'
Method: POST
Body | Type | Description |
---|---|---|
emails | List |
List of mails to send |
Return: List of invalid emails
- path: '/user/create'
Method: POST
Body | Type | Description |
---|---|---|
Users | Array |
array of users (each Object user has: Address, Email) |
- path: '/api/whitelist'
- Type: Whitelist
Field | Type | Description |
---|---|---|
PoolAddress | String |
Pool's pool address |
UserAddress | String |
User's address |
MaxAmount | INTEGER |
Maximum number of tokens a user can buy |
Status | String |
Pending - Approve - Denied |
- path: '/validUser?poolAddress=:poolAddress'
Method: GET
Param | Type | Description |
---|---|---|
poolAddress | String |
Pool's pool address |
Return:
Field | Type | Description |
---|---|---|
Users | INTEGER |
All users join whitelist (valid and invalid users) |
ValidUsers | INTEGER |
Valid users who can be added to whitelist |
WhitelistedUsers | INTEGER |
The users has been added to the whitelist |
WhitelistBegin | Integer |
When Whitelist starts |
WhitelistEnd | Interger |
When Whitelist ends |
- path: '/validUser?poolAddress=:poolAddress&page=:page&limit=:limit'
Method: GET
Param | Type | Description |
---|---|---|
poolAddress | String |
Pool's pool address |
page | Interger |
current page |
limit | Interger |
Maximum item in 1 page |
Return: all valid users that meet the pagination criteria and they can be added whitelist
- path: '/invalidUser?poolAddress=:poolAddress&page=:page&limit=:limit'
Method: GET
Param | Type | Description |
---|---|---|
poolAddress | String |
Pool's pool address |
page | Interger |
current page |
limit | Interger |
Maximum item in 1 page |
Return: all invalid users that meet the pagination criteria and they don't KYC
- path: '/allUser?poolAddress=:poolAddress&page=:page&limit=:limit'
Method: GET
Param | Type | Description |
---|---|---|
poolAddress | String |
Pool's pool address |
page | Interger |
current page |
limit | Interger |
Maximum item in 1 page |
Return: all users that meet the pagination criteria including KYC and non-KYC
- path: '/register'
Method: POST
Param | Type | Description |
---|---|---|
PoolAddress | String |
Pool's pool address |
UserAddress | String |
User's address |
- path: '/setWhitelist'
Method: POST
Param | Type | Description |
---|---|---|
PoolAddress | String |
Pool's pool address |
Whitelist | Array |
list of users and their MaxAmount |
- path: '/addUserToWhiteList/:PoolAddress'
Method: POST
Param | Type | Description |
---|---|---|
PoolAddress | String |
Pool's address |
Body | Type | Description |
---|---|---|
UserAddress | String |
User's address |
- path: '/importWhitelist/:PoolAddress'
Method: POST
Param | Type | Description |
---|---|---|
PoolAddress | String |
Pool's address |
File | Type | Description |
---|---|---|
file | File |
File uploaded |
- path: '/exportWhitelistTemplate'
Method: GET
Return: Template file
- path: '/api/'
- Type: Admin
Field | Type | Description |
---|---|---|
Username | String |
Username of admin |
Name | String |
Admin's fullname |
Password | String |
Admin's Password |
IsDeleted | Boolean |
Is admin banned |
- path: '/changePassword'
Method: PATCH
Body | Type | Description |
---|---|---|
username | String |
admin's username |
oldPassword | String |
admin's old password |
confirmPassword | String |
admin's old password for confirm |
newPassword | String |
admin's new password |
- path: '/admins/:username'
Method: GET
Param | Type | Description |
---|---|---|
username | String |
admin's username |
- path: '/admins/:username'
Method: GET
Body | Type | Description |
---|---|---|
username | String |
admin's username |
name | String |
Admin's fullname |
password | String |
Admin's Password |
- path: '/banAdmin'
Method: DELETE
Body | Type | Description |
---|---|---|
username | String |
admin's username |
- path: '/unbanAdmin'
Method: DELETE
Body | Type | Description |
---|---|---|
username | String |
admin's username |
- path: '/unbanAdmin'
Method: PATCH
Body | Type | Description |
---|---|---|
username | String |
admin's username which reset passqord |
superAdminPassword | String |
super Admin's Password to confirm |
- path: '/updateAdmin'
Method: PATCH
Body | Type | Description |
---|---|---|
username | String |
admin's username which update |
name | String |
admin's name for update |
- path: '/getAdminList?page=:page&limit=:limit'
Method: GET
Return: all admin that meet the pagination criteria