Hostel Management API
# **Hostel Management API 🏠** The **Hostel Management API** is designed to simplify **hostel booking, management, and user authentication**. It provides endpoints for **user registration, authentication, hostel listings, bookings, reviews, payments, and more**. ## **🌟 Features** - **User Authentication & Management** - User Registration (`/api/register/`) - User Login (`/api/login/`) - Password…
Hostel Management API endpoints
| Method | Endpoint | Description |
|---|---|---|
| Authorization | ||
| POST |
Register /api/register/ |
Registration endpoint |
| POST |
Login /api/login/ |
Login with your valid credentials. **username is recommended for hostel managers** and **student ID is recommended for student** in order for a successful tracking. **Password is… |
| GET |
Get Profile /api/profile/ |
Retrieves the authenticated user's profile. |
| PATCH |
Profile Update /api/profile/update/ |
Updates user profile information. |
| PUT |
Profile Update /api/profile/update/ |
Updates user profile information. |
| PATCH |
Change Password /api/password/change/ |
Allows the user to change their password. |
| PUT |
Change Password /api/password/change/ |
Allows the user to change their password. |
| POST |
Confirm Password Reset /api/password/reset/confirm/ |
Confirms the password reset and updates the user's password. |
| POST |
Password Reset /api/password/reset/ |
Sends a password reset email. |
| POST |
Logout /api/logout/ |
Logs out the authenticated user by deleting the authentication token. |
| DELETE |
Delete User /api/user/delete/ |
Deletes the authenticated user’s account. |
| Hostel Management | ||
| GET |
Get All Hostels /hostel/hostels/ |
Retrieves a list of all available hostels. |
| GET |
Search Hostels /hostel/hostels/search/?search/ |
**Filters** hostels based on location, name, top rating, etc ### Examples for searching by: *name or location* `hostel/hostels/search/?search={{room}}` *Top Rating*… |
| POST |
Add Hostels /hostel/hostels/ |
Add hostel information. |
| GET |
Get Hostel Details /hostel/{id}/details/ |
Get to know all information about a specific hostel. |
| Other endpoints | ||
| PUT |
Update Hostel Details /hostel/{id}/details/ |
Update information about a specific hostel. Partial update is accepted. |
Hostel Management API pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | 100 / hour |
|
| PRO Recommended | $100 / month | — |
|
| ULTRA | $350 / month | 100 / hour |
|
| MEGA | $500 / month | 50 / minute |
|