WAAMSorters API

Backend API for the WAAMSorters application to manage sorters, users, shops and game developers

Sorters 6

Sorters CRUD funcionality

raw

Create New Sorter  |  POST   {{URL}}/api/v1/sorters

Description

Create new sorter in database - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "name": "WAAM 2", "description": "Sorter ", "address": "Strzelecka 3 Rybnik 44200 Poland", "averageCommision": 5, "petContainer": 0, "aluContainer": 0, "glassContainer": 0, "glassDContainer": 0, "breakDownHead": "Working", "breakDownConveyor": "Working", "breakDownElectronic": "Working" }

Get All Sorters  |  GET   {{URL}}/api/v1/sorters

Description

Fetch all sorters from data base - Public

Get Single Sorter By ID  |  GET   {{URL}}/api/v1/sorters/

Description

Fetch single sorter by ID - Public

Get List Of Sorters In Radius Location  |  GET   {{URL}}/api/v1/sorters/radius/44-200/10

Description

Get list of location of sorters using zipcode and distance - Public

raw

Update Sorter  |  PUT   {{URL}}/api/v1/sorters/

Description

Update single sorter with unique ID - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Delete Sorter  |  DELETE   {{URL}}/api/v1/sorters/62b8a37e33cfab447f6aeaef

Description

Delete single sorter with unique ID - Admin

Authentication 9

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

raw

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

Description

Register user with encrypted password for - Public

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "name": "test 3", "email": "x@gmail.com", "password":"Password12" }
raw

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

Description

Login user with e-mail and password - Public

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "email": "x@gmail.com", "password":"Password12" }
raw

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

Description

Generate password token and send email - Public

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "email":"MyEmail@gmail.com" }
raw

Get Logged in User Via Token  |  GET   {{URL}}/api/v1/auth/me

Description

Get logged information - Only for account owner and Admin.

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "email":"artur.czachor@gmail.com", "password": "wamowski19" }

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

Description

Cleare token cookie of user account. - Only for account owner.

Confirmation Of User Registration  |  GET   {{URL}}/api/v1/auth/copy and paste link which you received on email adress

Description

Confirmation of user registration. You received on email link for confirmation. - Only for account owner.

raw

Reset Password  |  PUT   {{URL}}/api/v1/auth/resetpassword/129c972c374f2fcc846fd8c0b2a9808bbf44f83f

Description

Reset password for user with token . - Only for account owner.

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "password":"ResetPassword" }
raw

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

Description

Update name and email adress on user account. - Only for account owner and Admin.

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "name": "My Profile After Update" }
raw

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

Description

Update user password, send in the body currentPassword and newPassword. - Only for account owner.

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "currentPassword":"Password12", "newPassword":"Password1234567" }

Users CRUD For Admin 5

CRUD functionlaity for users only availeble to admins

raw

Create New User  |  POST   {{URL}}/api/v1/usercrudadmin/

Description

Create new usser with password, name and email - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "name": "CRUD New User", "email": "user@gmail.com", "password":"user1234" }

Get All Users  |  GET   {{URL}}/api/v1/usercrudadmin/

Description

Get full list of all users - Admin

raw

Get User With ID  |  GET   {{URL}}/api/v1/usercrudadmin/62c890eb184999c2f606d743

Description

Get user with ID - access only for Admin

raw

Update User  |  PUT   {{URL}}/api/v1/usercrudadmin/62bcb028db2c044fd6d15b81

Description

Find by ID and update user account - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "name":"Change Name" }
raw

Delete User  |  DELETE   {{URL}}/api/v1/usercrudadmin/62bdb242ae765ac6e98c353d

Description

Delete user with ID - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "name": "CRUD New User", "email": "user@gmail.com", "password":"user1234" }

Products 6

raw

Create New Product Game  |  POST   {{URL}}/api/v1/products

Description

Create new product game in data base . - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "title": "WAAMskot x", "category": "game", "distributor": "studio", "description": "Gra dla najmnieszych dzieci", "pointCost": 300 }
raw

Get All Products  |  GET   {{URL}}/api/v1/products

Description

Get list of all available products - Public

raw

Get Single Product  |  GET   {{URL}}/api/v1/products/62c7fb3162c64a3945855fff

Description

Get info of single product with ID - Public

formdata

Upload Product Photo  |  PUT   {{URL}}/api/v1/products/62c7fb3162c64a3945855fff/photo

Description

Upload photo for product with ID - Admin

Body
Key Value Description
file
raw

Update Product  |  PUT   {{URL}}/api/v1/products/62c7fb3162c64a3945855fff

Description

Update information of single product - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "title": "WAAMskot 5" }
raw

Delete Product  |  DELETE   {{URL}}/api/v1/products/62c7fb5462c64a3945856001

Description

Delete product form database. - Admin

Charity Events 6

Methods for get, update, post etc charity events in WAAM Aplication

raw

Create New Charity Event  |  POST   {{URL}}/api/v1/charityevents

Description

Create new charity event, need put organization and category. - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "title": "Zbudujmy razem boisko", "category": "pomoc szkołom", "organization":"helpSchool", "description": "zbiórka na boisko", "colectedAmount": 10 }
raw

Get All Charity Events  |  GET   {{URL}}/api/v1/charityevents

Description

Get all charity events - Public

formdata

Upload Chairty Event Photo  |  PUT   {{URL}}/api/v1/charityevents/62c81d8419bd4bc76400aa0e/photo

Description

Upload photo for charity event with ID - Admin

Body
Key Value Description
file
raw

Update Single Charity Event  |  PUT   {{URL}}/api/v1/charityevents/62c81d8419bd4bc76400aa0e

Description

Update info of single charity event - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "title": "Zbudujmy razem 3 boisko", "category": "pomoc szkołom", "organization":"helpSchool", "description": "zbiórka na boisko", "colectedAmount": 10 }

Education 6

Education products such us e-course also ebooks and audio-books

raw

Create New Education Product  |  POST   {{URL}}/api/v1/eduproducts

Description

Create new education product such as e-course/ebook/audiobook. - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "title": "Nauka JS", "category": "ebook", "distributor": "Helion", "description": "ebook do nauki JS", "pointCost": 300 }

Get All Education Products  |  GET   {{URL}}/api/v1/eduproducts

Description

StartFragment

Get all education products - Public

EndFragment

formdata

Upload Education Product Photo  |  PUT   {{URL}}/api/v1/eduproducts/63178fcb0dd49e356d5bf410/photo

Description

Upload photo for education product with ID. - Admin

Body
Key Value Description
file
raw

Update Education Product  |  PUT   {{URL}}/api/v1/eduproducts/63178fcb0dd49e356d5bf410

Description

Update education product, you can change description. - Admin

Headers
Key Value Description
Content-Type application/json

JSON Type

Body
{ "title": "Twój JS Podstawy" }