Welcome to the Rendeal Cleaning Service API documentation. This API provides various endpoints for managing cleaning services offered by Rendeal.
The Rendeal Cleaning Service API allows you to manage cleaning services, handle user authentication, and interact with our database. This document provides all the necessary information to interact with the API effectively.
- Bun (version 1.1 or higher)
- PostgreSQL - For database management
- Redis - For caching and session management
-
Clone the Repository:
git clone https://github.com/carfdev/api-rendeal.git cd api-rendeal -
Install Dependencies:
bun install
-
Set Up Environment Variables:
DATABASE_URL=your_postgres_database_url REDIS_URL=your_redis_url PORT=1337 JWT_SECRET=your_jwt_secret -
Start the Server:
bun dev
The server will be running at http://localhost:1337 by default.
- DATABASE_URL: The URL of your PostgreSQL database.
- REDIS_URL: The URL of your Redis instance.
- PORT: The port number where the server will listen for requests.
- JWT_SECRET: The secret key used for signing JWT tokens.
-
Method: POST
-
Description: Administrator Authentication. This endpoint allows administrators to log in to the system, providing a valid access token to perform administrative operations.
-
Request Example:
-
endpoint:
POST http://localhost:1337/v1/admin/login
-
body:
{ "email": "admin1@example.com", "password": "Password" }
-
-
Response:
{ "status": "success", "token": "token", "message": "Login successful" } -
Method: POST
-
Description: Create a new admin user. This endpoint allows the creation of a new administrator in the system. It requires a valid JWT token in the Authorization header and the email and password for the new admin in the request body.
-
Request Example:
-
endpoint:
POST http://localhost:1337/v1/admin/create
-
Headers:
Authorization: Bearer <your-jwt-token> -
body:
{ "email": "admin1@example.com", "password": "Password" }
-
-
Response:
{ "status": "success", "message": "Admin created successfully" }
-
Method: GET
-
Description: Retrieve the current administrator's information. This endpoint returns the details of the admin who is currently authenticated based on the provided JWT token.
-
Request Example:
-
endpoint:
GET http://localhost:1337/v1/admin/me
-
Headers:
Authorization: Bearer <your-jwt-token>
-
-
Response:
{ "status": "success", "data": { "id": "admin-id", "email": "admin@example.com", "rol": "admin" } }
-
Method: POST
-
Description: This endpoint is used to initiate the password recovery process. The user must provide their email address, and if it matches an account, a password reset link will be sent to the email.
-
Request Example:
-
endpoint:
POST http://localhost:1337/v1/admin/forgot-password
-
body:
{ "email": "admin1@example.com" }
-
-
Response:
{ "status": "success", "message": "Email sent successfully" }
-
Method: POST
-
Description: This endpoint is used to reset the user's password using the token provided in the password reset link.
-
Request Example:
-
endpoint:
POST http://localhost:1337/v1/admin/reset-password/token-sent-by-email
-
body:
{ "password": "newPassword123" }
-
-
Response:
{ "status": "success", "message": "Password changed successfully" }
Errors are handled with HTTP status codes and detailed messages. Common errors include:
400 Bad Request: The request was invalid or cannot be processed.401 Unauthorized: Authentication failed or is missing.404 Not Found: The requested resource was not found.500 Internal Server Error: An unexpected error occurred on the server.
We welcome contributions to the Rendeal Cleaning Service API. Please follow these steps:
- Fork the repository.
- Create a new branch (git checkout -b feature/your-feature).
- Make your changes and commit them (git commit -am 'Add new feature').
- Push to the branch (git push origin feature/your-feature).
- Create a new Pull Request.
This project is licensed under the Apache License - see the LICENSE file for details.