Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/EstefanoARG/FridgeRadar/llms.txt

Use this file to discover all available pages before exploring further.

The authentication endpoints are the entry point for every FridgeRadar client. Use POST /register to provision a new user account, then POST /login to receive a short-lived JWT Bearer token that must be included in the Authorization header of every subsequent request.

POST /api/v1/auth/register

Creates a new user account and returns the persisted user profile. No authentication is required.
nombres
string
required
The user’s first name(s).
apellidos
string
The user’s last name(s). Optional.
correo
string
required
A valid email address. Used as the login identifier and must be unique across all accounts.
password
string
required
Plain-text password. The service hashes it before persisting.

Response — 201 Created

id_usuario
integer
Auto-assigned primary key for the new user.
nombres
string
First name(s) as stored.
apellidos
string | null
Last name(s), or null if not provided.
correo
string
Verified email address.
fecha_registro
string (datetime) | null
ISO 8601 timestamp of when the account was created.
estado
string
Account status. Defaults to "activo" on creation.
curl -X POST https://api.fridgeradar.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "nombres": "Ana",
    "apellidos": "García",
    "correo": "ana.garcia@example.com",
    "password": "S3cur3Pass!"
  }'
StatusMeaning
201 CreatedAccount created successfully; user object returned.
422 Unprocessable EntityValidation error — missing required field or invalid email format.
409 ConflictAn account with that email already exists.

POST /api/v1/auth/login

Authenticates a user with their email and password and returns a JWT Bearer token. The request body must be sent as application/x-www-form-urlencoded (OAuth2 Password Flow). Pass the user’s email address in the username field.
username
string
required
The user’s email address (mapped to the correo field internally).
password
string
required
The user’s plain-text password.

Response — 200 OK

access_token
string
A signed JWT string. Include this value in the Authorization: Bearer <token> header for all protected endpoints.
token_type
string
Always "bearer".
curl -X POST https://api.fridgeradar.com/api/v1/auth/login \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "username=ana.garcia%40example.com&password=S3cur3Pass%21"
StatusMeaning
200 OKCredentials valid; token returned.
401 UnauthorizedIncorrect email or password.
422 Unprocessable EntityForm fields missing or malformed.

Build docs developers (and LLMs) love