Backend API for the WAAMSorters application to manage sorters, users, shops and game developers
Sorters CRUD funcionality
Create new sorter in database - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"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"
}
Fetch all sorters from data base - Public
Fetch single sorter by ID - Public
Get list of location of sorters using zipcode and distance - Public
Update single sorter with unique ID - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
Delete single sorter with unique ID - Admin
ROutes for user authentication including register, reset password, login etc
Register user with encrypted password for - Public
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"name": "test 3",
"email": "x@gmail.com",
"password": "Password12"
}
Login user with e-mail and password - Public
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"email": "x@gmail.com",
"password": "Password12"
}
Generate password token and send email - Public
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"email": "MyEmail@gmail.com"
}
Get logged information - Only for account owner and
Admin.
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"email": "artur.czachor@gmail.com",
"password": "wamowski19"
}
Cleare token cookie of user account. - Only for account
owner.
Confirmation of user registration. You received on email link for
confirmation. - Only for account owner.
Reset password for user with token . - Only for account
owner.
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"password": "ResetPassword"
}
Update name and email adress on user account. - Only for
account owner and Admin.
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"name": "My Profile After Update"
}
Update user password, send in the body currentPassword and
newPassword. - Only for account owner.
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"currentPassword": "Password12",
"newPassword": "Password1234567"
}
CRUD functionlaity for users only availeble to admins
Create new usser with password, name and email - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"name": "CRUD New User",
"email": "user@gmail.com",
"password": "user1234"
}
Get full list of all users - Admin
Get user with ID - access only for Admin
Find by ID and update user account - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"name": "Change Name"
}
Delete user with ID - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"name": "CRUD New User",
"email": "user@gmail.com",
"password": "user1234"
}
Create new product game in data base . - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"title": "WAAMskot x",
"category": "game",
"distributor": "studio",
"description": "Gra dla najmnieszych dzieci",
"pointCost": 300
}
Get list of all available products - Public
Get info of single product with ID - Public
Upload photo for product with ID - Admin
| Key | Value | Description |
|---|---|---|
| file |
Update information of single product - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"title": "WAAMskot 5"
}
Delete product form database. - Admin
Methods for get, update, post etc charity events in WAAM Aplication
Create new charity event, need put organization and category. - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"title": "Zbudujmy razem boisko",
"category": "pomoc szkołom",
"organization": "helpSchool",
"description": "zbiórka na boisko",
"colectedAmount": 10
}
Get all charity events - Public
Get info of single charity event - Public
Upload photo for charity event with ID - Admin
| Key | Value | Description |
|---|---|---|
| file |
Update info of single charity event - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"title": "Zbudujmy razem 3 boisko",
"category": "pomoc szkołom",
"organization": "helpSchool",
"description": "zbiórka na boisko",
"colectedAmount": 10
}
Delete of single charity event - Admin
Education products such us e-course also ebooks and audio-books
Create new education product such as e-course/ebook/audiobook. -
Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"title": "Nauka JS",
"category": "ebook",
"distributor": "Helion",
"description": "ebook do nauki JS",
"pointCost": 300
}
StartFragment
Get all education products - Public
EndFragment
Get single education product with ID. - Public
Upload photo for education product with ID. - Admin
| Key | Value | Description |
|---|---|---|
| file |
Update education product, you can change description. - Admin
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json |
JSON Type |
{
"title": "Twój JS Podstawy"
}
Delete education product. - Admin