Public
Documentation Settings

Express Server

Express based Production Server Demo APIs

Home

Collection of User API

GETHello World

/home/hello
Example Request
curl
curl --location '/home/hello'
200 OK
Example Response
json
{
  "message": "Hello World"
}
Content-Type

application/json; charset=utf-8

Content-Length

25

ETag

W/"19-c6Hfa5VVP+Ghysj+6y9cPi5QQbk"

Date

Fri, 05 Jun 2020 19:12:50 GMT

Connection

keep-alive

Auth

Collection of Authorization APIs

POSTSignup

/auth/signup

Create new user with an email & password

Bodyraw (json)
json
{
	"email": "u3@e.com",
	"password": "Pwd@1234"
}
Example Request
curl
curl --location '/auth/signup' \
--data-raw '{
	"email": "u3@e.com",
	"password": "Pwd@1234"
}'
200 OK
Example Response
json
{
  "status": "success",
  "message": "new user created",
  "user": "u3@e.com"
}
access_token

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6InUzQGUuY29tIiwiaWF0IjoxNTkxMzg0MjIxLCJleHAiOjE1OTEzODQ1MjF9.1IGHg2YyP_pGq3kOqpMHOTEE6XW2iizbTeaaLumUY0s

Content-Type

application/json; charset=utf-8

Content-Length

67

ETag

W/"43-hbluvvIjYUv4oeuBmrskdHqiGVs"

Date

Fri, 05 Jun 2020 19:10:21 GMT

Connection

keep-alive

POSTSignin

/auth/signin

Signin using email & password

Bodyraw (json)
json
{
	"email": "u1@e.com",
	"password": "Pwd@1234"
}
Example Request
curl
curl --location --request POST '/auth/signin' \
--data ''
422 Unprocessable Entity
Example Response
json
{
  "status": "error",
  "message": "Invalid Inputs",
  "errors": [
    {
      "value": "",
      "msg": "Invalid value",
      "param": "email",
      "location": "body"
    },
    {
      "value": "",
      "msg": "Invalid value",
      "param": "password",
      "location": "body"
    }
  ]
}
Content-Type

application/json; charset=utf-8

Content-Length

197

ETag

W/"c5-Krv6MRchTVWtA+IuufC3gXZrn0k"

Date

Fri, 05 Jun 2020 19:13:11 GMT

Connection

keep-alive

POSTSignout

/auth/signout

Signout clears out your access_token

HEADERS
access_token

{{access_token}}

Example Request
curl
curl --location --request POST '/auth/signout' \
--header 'access_token: {{access_token}}' \
--data ''
400 Bad Request
Example Response
json
{
  "status": "error",
  "message": "Bad Request",
  "errors": []
}
Content-Type

application/json; charset=utf-8

Content-Length

54

ETag

W/"36-dReCB7b5dPjojTLoQ//BPiFzt9c"

Date

Fri, 05 Jun 2020 19:12:16 GMT

Connection

keep-alive