Ajo-API

Handling Errors

When a field is required and it is not supplied, the database throws an error of the form { "error": [ "Name is required." ]}

For most endpoints, there is a validator to return the error in the form { error: "Name is required." }

Basically you may have to access the error as an array very few times e.g response.error[0] at other times response.error

Look at individual endpoints to see how errors are returned.

Email Verification

Some endpoints require users to be verified to use them. If user is not verified, error is returned in the form { "error": [ "Please verify your email to use this service" ]} as you will see in the "submit review" endpoint below.

AUTHORIZATIONBearer Token

Token

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2MjY0NGVlOTU3YjU4ZjdmMzJkOTgxNjYiLCJpYXQiOjE2NTA3NDEyMTksImV4cCI6MTY1MDgyNzYxOX0.exmMfrxiwgB2fS38xgYJiZ4HruYf6wxgVHuqD-GJOHw

Auth

AUTHORIZATIONBearer Token

This folder is using Bearer Token from collectionAjo-API

POSTRegister user

localhost:4000/api/auth/signup

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionAjo-API

Bodyraw (json)

json

{
    "email": "komozy2000@gmail.com",
    "firstname": "Daniel",
    "lastname": "Komolafe",
    "password": "dan123"
}

Example Request

curl

curl --location 'localhost:4000/api/auth/signup' \
--data-raw '{
    "email": "komozy2000@gmail.com",
    "firstname": "Daniel",
    "lastname": "Komolafe",
    "password": "dan123"
}'

200 OK

Example Response

json

{
  "message": "Signup success! Please signin"
}

X-Powered-By

Express

Content-Type

application/json; charset=utf-8

Content-Length

ETag

W/"2b-lPxy855bP7B0iu0C/xKWVow+zao"

Date

Sat, 23 Apr 2022 19:09:30 GMT

Connection

keep-alive

Keep-Alive

timeout=5

POSTLogin user

localhost:4000/api/auth/signin

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionAjo-API

Bodyraw (json)

json

{
    "email": "komozy2000@gmail.com",
    "password": "dan123"
}

Example Request

curl

curl --location 'localhost:4000/api/auth/signin' \
--data-raw '{
    "email": "komozy2000@gmail.com",
    "password": "dan123"
}'

200 OK

Example Response

json

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2MjY0NGVlOTU3YjU4ZjdmMzJkOTgxNjYiLCJpYXQiOjE2NTA3NDEyMTksImV4cCI6MTY1MDgyNzYxOX0.exmMfrxiwgB2fS38xgYJiZ4HruYf6wxgVHuqD-GJOHw",
  "user": {
    "_id": "62644ee957b58f7f32d98166",
    "username": "komozy20008562",
    "email": "komozy2000@gmail.com",
    "firstname": "Daniel",
    "lastname": "Komolafe",
    "photo": "/avatar.png",
    "createdAt": "2022-04-23T19:09:29.810Z",
    "updatedAt": "2022-04-23T19:09:29.810Z",
    "__v": 0
  }
}

X-Powered-By

Express

Set-Cookie

token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2MjY0NGVlOTU3YjU4ZjdmMzJkOTgxNjYiLCJpYXQiOjE2NTA3NDEyMTksImV4cCI6MTY1MDgyNzYxOX0.exmMfrxiwgB2fS38xgYJiZ4HruYf6wxgVHuqD-GJOHw; Path=/

Content-Type

application/json; charset=utf-8

Content-Length

436

ETag

W/"1b4-jdrTWsHAOuLKSjOh5hwbWKaKPfQ"

Date

Sat, 23 Apr 2022 19:13:39 GMT

Connection

keep-alive

Keep-Alive

timeout=5