KodeKamper | RESTful API

KodeKamper API

KodeKamper is an extensive backend RESTful API service that provide data for consumer to build their own frontend platform. Postman for automated test scenario, we setup repeatable tests which Setup, Test, and ClearUp the requests.

Authentication 8

Routes for user authentication including register, login, reset password, etc

raw

Forgot Password | POST {{URL}}/api/v1/auth/forgotpassword

Description

The forgot password link, sends the reset token link to the user’s email that will then take the user to new password form. This token has an expiration time of 10 minutes.

Body

{ "email": "{{User_Email}}" }

Get Current Logged In User | GET {{URL}}/api/v1/auth/me

Description

Get logged in user via Token.

raw

Login User | POST {{URL}}/api/v1/auth/login

Description

Body

{ "email": "[email protected]", "password": "123456" }

Logout User / Clear Cookie | GET {{URL}}/api/v1/auth/logout

Description

Clear token cookie once the user logs out.

raw

Register User | POST {{URL}}/api/v1/auth/register

Description

Add user to database with encrypted password.

Body

{ "name": "Publisher Account", "email": "[email protected]", "role": "publisher", "password": "123456" }

raw

Reset Password | PUT {{URL}}/api/v1/auth/resetpassword/4abfd2b2eeab6e9c9d7fa063ad394684e243d112

Description

Reset user password using a token.

Body

{ "password": "Col6PWXdzp58RUOcV" }

raw

Update Password | PUT {{URL}}/api/v1/auth/updatepassword

Description

Logged in user update/change password.

Body

{ "currentPassword": "{{User_Password}}", "newPassword": "{{User_New_Password}}" }

raw

Update User Details | PUT {{URL}}/api/v1/auth/updatedetails

Description

Update logged in user name and email.

Body

{ "name": "{{User_New_Name}}", "email": "{{User_New_Email}}" }

Bootcamps 7

Fetch all bootcamps from the database. Includes pagination, filtering, etc

raw

Create New Bootcamp | POST {{URL}}/api/v1/bootcamps

Description

Create single bootcamp

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "name": "Kodekamper Bootcamp", "description": "Is coding your passion? Codemasters will give you the skills and the tools to become the best developer possible. We specialize in front end and full stack web development", "website": "https://kodekamper.com", "phone": "kodekamper.com", "email": "[email protected]", "address": "45 Upper College Rd Kingston RI 02881", "careers": [ "Mobile Development", "Web Development", "Data Science", "Business" ], "housing": false, "jobAssistance": true, "jobGuarantee": true, "acceptGi": true }

raw

Delete Bootcamp | DELETE {{URL}}/api/v1/bootcamps/{{Bootcamp_ID}}

Description

Delete single bootcamp by ID.

raw

Get All Bootcamps | GET {{URL}}/api/v1/bootcamps

Description

Get all the bootcamps.

formdata

Get Bootcamps By Distance | GET {{URL}}/api/v1/bootcamps/radius/53100/50

Description

Get bootcamps within the area of your radius of a specific zip-code

Body

Get Single Bootcamp | GET {{URL}}/api/v1/bootcamps/{{Bootcamp_ID}}

Description

Get single bootcamp by ID.

raw

Update Bootcamp | PUT {{URL}}/api/v1/bootcamps/{{Bootcamp_ID}}

Description

Update single bootcamp by ID.

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "name": "Test Bootcamp", "address": "45 Upper College Rd Kingston RI 02881", "careers": [ "Data Science", "Business" ] }

Upload Photo | PUT {{URL}}/api/v1/bootcamps/617057803ba5bc999e7b09c0/photo

Description

Upload image for a single bootcamp by ID.

Courses 6

raw

Add Course | POST {{URL}}/api/v1/bootcamps/{{Bootcamp_ID}}/courses

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "title": "Full Stack Web Dev", "description": "In this course you will learn all about the front end with HTML, CSS and JavaScript. You will master tools like Git and Webpack and also learn C# and ASP.NET with Postgres", "weeks": 10, "tuition": 12000, "minimumSkill": "intermediate", "scholarhipsAvailable": true }

Delete course | DELETE {{URL}}/api/v1/courses/{{Course_ID}}

Description

Delete single course by ID.

Get All Courses | GET {{URL}}/api/v1/courses

Description

Get Courese for bootcamps

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Get Courses For Bootcamp | GET {{URL}}/api/v1/bootcamps/{{Bootcamp_ID}}/courses

Description

Get the Courses from a single bootcamp.

Get Single Course | GET {{URL}}/api/v1/courses/{{Course_ID}}

Description

Get a single course by ID from the courses.

raw

Update Course | PUT {{URL}}/api/v1/courses/5d725a4a7b292f5f8ceff789

Description

Update single course by ID

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "title": "Mind Development TEST", "description": "This course will provide you with all of the essentials to become a successful frontend web developer. You will learn to master HTML, CSS and front end JavaScript, along with tools like Git, VSCode and front end frameworks like Vue", "weeks": 5, "tuition": 4500, "minimumSkill": "beginner", "scholarhipsAvailable": false }

Health Check 2

Here we send GET requests and verify that the response data is correct.

raw

Get HealthCheck Fail | GET {{URL}}

Body

{ }

Get HealthCheck Pass | GET {{URL}}

Reviews 6

raw

Add Review | POST {{URL}}/api/v1/bootcamps/{{Bootcamp_ID}}/reviews

Description

User or Admin can add reviews to a specific bootcamp.

Body

{ "title": "Was worth the investment", "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": "3" }