Git Product home page Git Product logo

ido-admin-api's Introduction

IDO-admin-page-api

Internal project - API Server for admin of IDO platform to manage database

Admin

Applied projects

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
Twitter 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 |

getAppliedProject

path: '/applied/all'

Method: GET

Param Type Description
None None None

Return: All projects are not deletes

getAppliedProjectPagination

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

getAppliedProjectById

path: '/applied/:id'

Method: GET

Param Type Description
id Interger ID of applied project will be get

Return: project is not deletes

updateAppliedProject

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

deleteProject

path: '/applied/:id/delete'

Method: DELETE

Param Type Description
id Interger ID of applied project will be deleted

createAppliedProject

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
Twitter 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

getDevelopmentState

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

getStatus

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

exportAppliedProjectAsXlsx

path: '/applied/export'

Method: GET

Return: Datas.xlsx file

Pool projects

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
Twitter 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

getPools

path: '/pool/all'

Method: GET

Param Type Description
None None None
Body Type Description
None None None

Return: All pools are in the system

getPoolsPagination

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

getPoolById

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

createPool

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
Twitter 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

Users

path: '/api/user'
Type: User
Field Type Description
Id String Pool ID (yi-1)
Address String User's address
Email String User's email

getUsersPagination

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

sendConfirmKYCEmail

path: '/user/sendConfirmKYCEmail'

Method: POST

Body Type Description
emails List List of mails to send

Return: List of invalid emails

createUsers

path: '/user/create'

Method: POST

Body Type Description
Users Array array of users (each Object user has: Address, Email)

Whitelist

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

getWhitelistPagination

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

getValidUserPagination

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

getInvalidUserPagination

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

getAllUserPagination

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

registerWhitelist

path: '/register'

Method: POST

Param Type Description
PoolAddress String Pool's pool address
UserAddress String User's address

updateWhitelist

path: '/setWhitelist'

Method: POST

Param Type Description
PoolAddress String Pool's pool address
Whitelist Array list of users and their MaxAmount

addUserToWhiteList

path: '/addUserToWhiteList/:PoolAddress'

Method: POST

Param Type Description
PoolAddress String Pool's address
Body Type Description
UserAddress String User's address

importWhitelist

path: '/importWhitelist/:PoolAddress'

Method: POST

Param Type Description
PoolAddress String Pool's address
File Type Description
file File File uploaded

exportWhitelistTemplate

path: '/exportWhitelistTemplate'

Method: GET

Return: Template file

Admins

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

changePassword

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

getAdmin

path: '/admins/:username'

Method: GET

Param Type Description
username String admin's username

createAdmin

path: '/admins/:username'

Method: GET

Body Type Description
username String admin's username
name String Admin's fullname
password String Admin's Password

banAdmin

path: '/banAdmin'

Method: DELETE

Body Type Description
username String admin's username

unbanAdmin

path: '/unbanAdmin'

Method: DELETE

Body Type Description
username String admin's username

resetPassword

path: '/unbanAdmin'

Method: PATCH

Body Type Description
username String admin's username which reset passqord
superAdminPassword String super Admin's Password to confirm

updateAdmin

path: '/updateAdmin'

Method: PATCH

Body Type Description
username String admin's username which update
name String admin's name for update

getAdminList

path: '/getAdminList?page=:page&limit=:limit'

Method: GET

Return: all admin that meet the pagination criteria

ido-admin-api's People

Contributors

darkdrake132 avatar quochiep99 avatar

Watchers

James Cloos avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.