DEVCAMP MASTERY - backendAPI

This contains full documentation of routes about the backend server API for the DEVCAMP MASTERY website.

Admin Panel 4

Routes for admins to manage user accounts.

Only for user with role admin and must be logged in(apply to all routes from Admin Panel collection.

Get all users  |  GET   http://localhost:3000/api/v1/admin/users

Description

Get a list with all users from database.

raw

Create a new user  |  POST   http://localhost:3000/api/v1/admin/users

Description

Create a new user.

Headers
Key Value Description
Content-Type application/json
Body
{ "name": "user", "password": "123456", "email": "user@gmail.com", "role": "user" }
raw

Update a user's details  |  PUT   http://localhost:3000/api/v1/admin/users/5d7a514b5d2c12c7449be045

Description

Update details for a specific user using his ID.

Headers
Key Value Description
Content-Type application/json
Body
{ "name": "Different user name" }

Authentication 8

Routes that includes all functionality for a user to interact with the website (login, logout, reset password etc)

raw

Register user  |  POST   http://localhost:3000/api/v1/auth/register

Description

Add a new user to database with a encrypted password.

Headers
Key Value Description
Content-Type application/json
Body
{ "name": "Manole<h1><br>'Alert</script>", "email": "asd@gmail.com", "role": "publisher", "password": "12345678" }
raw

Login user  |  POST   http://localhost:3000/api/v1/auth/login

Description

Log in a user, also create a JWT token for persisting logged session.

Headers
Key Value Description
Content-Type application/json
Body
{ "email": , "password": "123456" }
raw

Reset forgot password  |  POST   http://localhost:3000/api/v1/auth/forgot-password

Description

Generate a reset password token and send it via email in order to reset a forgotten password.

Headers
Key Value Description
Content-Type application/json
Body
{ "email": "publisher@gmail.com" }

Get current logged in user  |  GET   http://localhost:3000/api/v1/auth/me

Description

Get all data about the current logged in user.

Log out user  |  GET   http://localhost:3000/api/v1/auth/logout

Description

Log out a user deleting token cookie.

raw

Reset user password  |  PUT   http://localhost:2450/api/v1/auth/reset-password/a5122fab9ee8cb4dcbdeb97613bca88bdd953705

Description

Reset user password using the token from email, sent via ‘reset forgot password’ route.

Headers
Key Value Description
Content-Type application/json
Body
{ "newPassword": "altaparola" }
raw

Update user details  |  PUT   http://localhost:2450/api/v1/auth/update-info

Description

Update email or username for logged in user.

Headers
Key Value Description
Content-Type application/json
Body
{ "newName": "User Account" }
raw

Update user password  |  PUT   http://localhost:2450/api/v1/auth/update-password

Description

Update password for logged in user.

Headers
Key Value Description
Content-Type application/json
Body
{ "currentPassword": "altaparola", "newPassword": "123456" }

Bootcamps 7

Manage Bootcamps (CRUD functionality)

raw

Get all the bootcamps  |  GET   http://localhost:3000/api/v1/bootcamps

Description

Fetch all the bootcamps available from the database

Get bootcamps by distance  |  GET   http://localhost:3000/api/v1/bootcamps/radius/02118/21

Description

Get bootcamps within a radius of a specific zipcode (distance in km)

raw

Add a new bootcamp  |  POST   http://localhost:3000/api/v1/bootcamps/

Description

Create a new bootcamp and add it to the database.

  • must be logged in
  • only for users with the role publisher
  • limit of one bootcamp per user


Headers
Key Value Description
Content-Type application/json
Body
{ "name": "ModernTech Bootcamp", "description": "Is coding your passion? Codemasters will give you the skills and the tools to become the best developer possible. We specialize in full stack web development and data science", "website": "https://codemasters.com", "phone": "(333) 333-3333", "email": "enroll@codemasters.com", "address": "85 South Prospect Street Burlington VT 05405", "careers": ["Web Development", "Data Science", "Business"], "housing": false, "jobAssistance": false, "jobGuarantee": false, "acceptGi": false, "slug": "alt value" }
raw

Update the bootcamp by ID  |  PUT   http://localhost:3000/api/v1/bootcamps/5d713a66ec8f2b88b8f830b8

Description

Update a specific bootcamp in the database.

  • must be logged in
  • only for user with the role publisher
  • must own the specified Bootcamp


Headers
Key Value Description
Content-Type application/json
Body
{ "averageCost": 5000, "averageRating": 4 }
formdata

Upload photo  |  PUT   http://localhost:3000/api/v1/bootcamps/620cd0d9dff13c7c7a6d63a1/photo

Description

Upload photo profile for a specific bootcamp.

  • must be logged in
  • only for users with the role publisher
  • must own the specified Bootcamp
  • only image/photo file are accepted and less than 1MB


Body
Key Value Description
photo

Delete the bootcamp by ID  |  DELETE   http://localhost:3000/api/v1/bootcamps/620cd84269c2b398f44cc8d2

Description

Delete a specific bootcamp from database.

  • must be logged in
  • only for users with the role publisher
  • must own the specified Bootcamp


Courses 5

Manage Courses (CRUD functionality)

Get all courses  |  GET   http://localhost:3000/api/v1/courses

Description

Get all courses from the database.

raw

Create a new Course  |  POST   http://localhost:3000/api/v1/courses

Description

Create a new course for a specific Bootcamp and add it to the database.

  • bootcamp will be passed in body by “bootcamp” field
  • must be logged in
  • only for user with the role publisher
  • must own the specified Bootcamp


Headers
Key Value Description
Content-Type application/json
Body
{ "title": "Bootcamp Crypto 22", "description": "Get started building mobile applications for IOS using Swift and other tools", "weeks": 8, "tuition": 9800, "minimumSkill": "intermediate", "scholarhips": false, "bootcamp": "5d713a66ec8f2b88b8f830b8" }
raw

Update a course  |  PUT   http://localhost:3000/api/v1/courses/620d41d9f1274d6d67f17631

Description

Update a specific course in the database.

  • must be logged in
  • only for users with the role publisher
  • must own the specified Bootcamp


Headers
Key Value Description
Content-Type application/json
Body
{ "title":"Programare web la alt nivel" }

Delete a course  |  DELETE   http://localhost:3000/api/v1/courses/620d41d9f1274d6d67f17631

Description

Delete a course from the database.

  • must be logged in
  • only for users with the role publisher
  • must own the specified Bootcamp


Headers
Key Value Description
Content-Type application/json

Reviews 5

Manage Reviews (CRUD functionality)

Get all reviews  |  GET   http://localhost:3000/api/v1/reviews

Description

Get all reviews from the database.

raw

Create a new review  |  POST   http://localhost:3000/api/v1/reviews

Description

Write a new reviews for a specific Bootcamp and add it to the database.

  • must be logged in
  • only for users with the role user
  • limit of one review per Bootcamp


Headers
Key Value Description
Content-Type application/json
Body
{ "title": "Best instructors", "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec viverra feugiat mauris id viverra. Duis luctus ex sed facilisis ultrices. Curabitur scelerisque bibendum ligula, quis condimentum libero fermentum in. Aenean erat erat, aliquam in purus a, rhoncus hendrerit tellus. Donec accumsan justo in felis consequat sollicitudin. Fusce luctus mattis nunc vitae maximus. Curabitur semper felis eu magna laoreet scelerisque", "rating": "asd", "bootcamp": "5d725a037b292f5f8ceff787" }
raw

Update a review  |  PUT   http://localhost:3000/api/v1/reviews/621d1cb60cd64c59557e0274

Description

Update a specific review in database.

  • must be logged in
  • only for users with the role user
  • must own the specified Review


Headers
Key Value Description
Content-Type application/json
Body
{ "title": "awesome test", "text": "adasdasdasdasda", "rating": 8, "bootcamp": "621d1cb60cd64c59557e0275" }

Delete a review  |  DELETE   http://localhost:3000/api/v1/reviews/621d3e285e3e32cb9b6573f7

Description

Delete a review from the database.

  • must be logged in
  • only for users with the role user
  • must own the specified Review