Skip to content

Routes and APIs

Song Zheng edited this page Mar 23, 2020 · 7 revisions

Introduction

APIs you need

POST /signup

Sign up user

Request body

base64 encoded JSON string 
{
  username: 'username',
  password: 'password',
  email: '[email protected]'
}

Response

Success

{
  status: 'success' 
}

Error

{
  error: {
    message: 'failed to sign up'
  }
}

POST /login

Used to log user in.

Request Body

base64 encoded JSON string
{
  username: 'username',
  password: 'password'
}

Response

Success

{
  status: 'success'
}

Error

{
  error: {
    message: 'Failed to login'
  }
}

POST /validate

Request Body

base64 encoded JSON string
{
  email: 'email',
  username: 'username',
  password: 'password'
}

Response

Success

{
  status: 'success'
}

Error

{
  error: {
    message: 'Username is too short'
  }
}

GET /logout

Logout user

Response

Success

{
  status: 'success' 
}

Error

{
  error: {
    message: 'failed to logout'
  }
}

POST /databases

Create a database for the currently logged in user

Request Body

base64 encoded JSON string
{
  
  name: 'postgres'
}

Response

Success

{
  status: 'success' 
}

Error

{
  error: {
    message: 'failed to create database'
  }
}

GET /databases

Get all databases for the currently logged in user.

Response

Success

{
  data: [{postgres: {...}}, {mongoDB: {...}}] 
}

Error

{
  error: {
    message: 'failed to get databases'
  }
}

POST /databases/setup

.

Request body

base64 encoded JSON string
{
  password: 'c0d3r'
}

Response

Success

{
  status: 'success'
}

Error

{
  error: {
    message: 'database setup failed'
  }
}

POST /confirm

Resend if email has expired or not been sent

Request body

base64 encoded JSON string
{
  email: '[email protected]'
}

Response

Success

{
  status: 'success'
}

Error

{
  error: {
    message: 'email was not sent'
  }
}
Clone this wiki locally