Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/4rt21/backend-proyecto/llms.txt

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

Fraud Reporting and Moderation API

Build secure applications with real-time fraud detection, user reporting, and content moderation. Built on NestJS with JWT authentication and WebSocket support.

Get StartedAPI Reference

Quick Start

Get up and running with FalconAlert API in minutes

1

Set up your environment

Clone the repository and install dependencies:
git clone https://github.com/4rt21/backend-proyecto.git
cd backend-proyecto
npm install
2

Configure your database

Create a .env file with your MySQL credentials:
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=your_user
MYSQL_PASSWORD=your_password
MYSQL_DB=Ofraud
Import the database schema:
mysql -u your_user -p Ofraud < backup.sql
3

Start the server

Run the development server:
npm run start:dev
The API will be available at http://localhost:3000 and the Swagger documentation at http://localhost:3000/docs.
4

Make your first API call

Register a new user:
curl -X POST http://localhost:3000/users/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "password": "securePassword123"
  }'

{
  "id": 1,
  "name": "John Doe",
  "email": "john@example.com",
  "username": "happy_john123",
  "created_at": "2024-03-04T12:00:00.000Z",
  "role_id": 1
}

Core Features

Everything you need to build a fraud reporting platform

Authentication

JWT-based auth with access and refresh tokens for secure API access

Report Management

Create, update, and moderate fraud reports with category organization

Real-time Updates

WebSocket notifications for instant report status updates

Image Uploads

S3 and local storage support for report evidence images

Admin Controls

Full admin panel for user and report moderation

Analytics

Dashboard with statistics on reports, users, and trends

Explore by Topic

Browse documentation by feature area

User Management

Registration, profiles, settings, and authentication flows

Reports

Report lifecycle from creation to moderation and resolution

Categories

Organize reports by category for better classification

Moderation

Admin workflows for reviewing and approving reports

API Endpoints

Explore the complete REST API reference

Authentication

Login, token refresh, and verification endpoints

View endpoints

Users

Registration, profile management, and user settings

View endpoints

Reports

Create, list, update, and delete fraud reports

View endpoints

Admin

Administrative controls for user and report management

View endpoints

Ready to get started?

Follow our quickstart guide to set up FalconAlert API in your environment and make your first API call.

Get Started