Carsify

MIT License Nest JS

A REST API that enables registered users to view and create reports for cars at their convenience.

Features

  • User creation
  • Authentication - Secured passwords (Rainbow attack proof)
  • User deletion
  • API routes
  • Report creation
  • Report approval by administrative user

API Reference - Users

User sign up

  POST https://carsify-api.vercel.app/auth/signup
Parameter Type Description Required
email string Email address of user Yes
password string Password of user Yes

User sign in

  POST https://carsify-api.vercel.app/auth/signin
  
Parameter Type Description Required
email string Email address of user Yes
password string Password of user Yes

Get current user

  GET https://carsify-api.vercel.app/auth/current-user

Authorization: bearer ${token}

User Sign out

  POST https://carsify-api.vercel.app/auth/signout

Find all users

  GET https://carsify-api.vercel.app/auth/?$email=${email}

Find user by ID

  GET https://carsify-api.vercel.app/auth/:id

Delete user

  GET https://carsify-api.vercel.app/auth/:id

Update user email

  PATCH https://carsify-api.vercel.app/auth/:id

Change user password

  POST https://carsify-api.vercel.app/auth/:id
Parameter Type Description Required
email string Email address of user Yes
oldPassword string Current password of user Yes
password string New password of user Yes

API Reference - Reports

Create reports

  POST https://carsify-api.vercel.app/reports

content-type: application/json

Authorization: bearer ${token}

Parameter Type Description Required
make string Make of car Yes
model string Model of car Yes
year string Year of car Yes
mileage string Mileage of car Yes
lng string Longitude Yes
lat string Latitude Yes
price string Price of car Yes

Change approval status by admin user

  POST https://carsify-api.vercel.app/reports/:id

content-type: application/json

Authorization: bearer ${token}

Parameter Type Description Required
approved string approval status Yes

Get estimate for existing vehicle

  GET https://carsify-api.vercel.app/auth/?make=${make}&model=${model}&lng=${lng}&lat=${lat}&mileage=${mileage}&year=${year}

Feedback

If you have any feedback, please reach out to me at chisomije92@gmail.com