Event Management System API Documentation

Overview
Authentication
API Endpoints
Models & Data Structures
Helper Functions
Frontend Components
Usage Examples

Overview

This is a comprehensive Laravel-based event management system that handles event creation, registration, payments, rankings, and merchandise. The system supports multiple user roles including organizers, administrators, and participants.

Key Features

Event creation and management
User registration and authentication
Payment processing (Redsys integration)
Event rankings and statistics
Merchandise catalog management
Multi-language support
Discount and promotion management
Communication system

Authentication

Sanctum Authentication

The API uses Laravel Sanctum for authentication. Most endpoints require authentication via the auth:sanctum middleware.

// Get authenticated user
Route::middleware('auth:sanctum')->get('/user', function (Request $request) {
    return $request->user();
});

Session Authentication

Web routes use session-based authentication with the auth middleware.

API Endpoints

Authentication Endpoints

POST /api/user/login

Request Body:

{
    "email": "user@example.com",
    "password": "password"
}

Response:

{
    "success": true,
    "user": {
        "id": 1,
        "name": "John Doe",
        "email": "user@example.com"
    }
}

User Registration

POST /api/user/register

Request Body:

{
    "name": "John Doe",
    "email": "user@example.com",
    "password": "password",
    "password_confirmation": "password"
}

Event Management API

Get Events (Filtered)

GET /api/v1/events/filter

Query Parameters:

search (string): Search term for event name
category (integer): Category ID filter
date_from (date): Start date filter
date_to (date): End date filter
status (string): Event status filter

Response:

{
    "data": [
        {
            "id": 1,
            "name": "Marathon 2024",
            "description": "Annual marathon event",
            "date_from": "2024-06-15T08:00:00Z",
            "date_to": "2024-06-15T18:00:00Z",
            "participants": 1000,
            "enrolled": 750,
            "category": {
                "id": 1,
                "name": "Running"
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "total": 10,
        "per_page": 15
    }
}

Create Event

POST /api/eventos

Request Body:

{
    "name": "New Event",
    "description": "Event description",
    "address": "123 Main St",
    "pagina_web": "https://example.com",
    "date_from": "2024-07-01",
    "time_from": "09:00",
    "date_to": "2024-07-01",
    "time_to": "17:00",
    "date_from_register": "2024-06-01",
    "time_from_register": "00:00",
    "date_to_register": "2024-06-30",
    "time_to_register": "23:59",
    "participants": 500,
    "create_latitude": 40.4168,
    "create_longitude": -3.7038,
    "timezone": "Europe/Madrid"
}

Update Event

POST /api/eventos/{eventoId}

Request Body: Same as create event

Get Event Forms

GET /api/eventos/forms/{eventoId}

Response:

{
    "forms": {
        "fields": [
            {
                "type": "text",
                "label": "Full Name",
                "required": true,
                "name": "full_name"
            },
            {
                "type": "email",
                "label": "Email",
                "required": true,
                "name": "email"
            }
        ]
    }
}

Update Event Forms

POST /api/eventos/forms/{eventoId}

Request Body:

{
    "forms": {
        "fields": [
            {
                "type": "text",
                "label": "Full Name",
                "required": true,
                "name": "full_name"
            }
        ]
    }
}

Checkout & Payment API

Get Event Products

GET /api/event-products/{event_id}

Response:

{
    "products": [
        {
            "id": 1,
            "name": "Event T-Shirt",
            "price": 25.00,
            "stock": 100,
            "variants": [
                {
                    "id": 1,
                    "attributes": {
                        "size": "M",
                        "color": "Blue"
                    },
                    "price": 25.00,
                    "stock": 50
                }
            ]
        }
    ]
}

Add Product to Cart

POST /api/add-product-to-cart

Request Body:

{
    "event_id": 1,
    "product_id": 1,
    "variant_id": 1,
    "quantity": 2
}

Remove from Cart

POST /api/remove-from-cart

Request Body:

{
    "event_id": 1,
    "product_id": 1,
    "variant_id": 1
}

Get Product Variants

GET /api/product-variants/{productId}

Response:

{
    "variants": [
        {
            "id": 1,
            "attributes": {
                "size": "S",
                "color": "Red"
            },
            "price": 25.00,
            "stock": 25
        }
    ]
}

Find Product Variant

POST /api/find-product-variant

Request Body:

{
    "product_id": 1,
    "attributes": {
        "size": "M",
        "color": "Blue"
    }
}

Rankings API

Get Event Rankings

GET /events/{eventId}/rankings

Create Ranking

POST /events/{eventId}/rankings

Request Body:

{
    "name": "Overall Ranking",
    "description": "Overall event ranking",
    "criteria": [
        {
            "field": "finish_time",
            "weight": 1.0,
            "order": "asc"
        }
    ]
}

Recalculate Rankings

POST /events/{eventId}/rankings/{rankingId}/recalculate

Export Rankings

GET /events/{eventId}/rankings/export

Discounts API

Get Discounts

GET /api/descuentos

Create Discount

POST /api/descuentos

Request Body:

{
    "name": "Early Bird Discount",
    "code": "EARLYBIRD",
    "amount": 20,
    "type_amount": 1,
    "quantity": 100,
    "evento_id": 1
}

Update Discount

POST /api/descuentos/{discountId}

Delete Discount

GET /api/descuentos/delete/{discountId}

Communications API

Get Communications

GET /api/eventos/communications

Send Communication

POST /api/eventos/communications/send-email

Request Body:

{
    "event_id": 1,
    "subject": "Event Update",
    "message": "Important information about the event",
    "recipients": ["all", "confirmed", "pending"]
}

Generate Report

GET /api/eventos/generate-report/{eventId}/{type}

Types: participants, payments, rankings

Merchandise API

Get Catalogs

GET /api/catalogos/{id}

Create Catalog

POST /api/merchant/store

Request Body:

{
    "name": "Event Merchandise",
    "description": "Official event merchandise",
    "event_id": 1
}

Update Catalog

PUT /api/catalogos/{id}

Delete Catalog

DELETE /api/catalogos/{id}

Upload Product Image

POST /api/merchant/catalogos/productos/uploadImage

Request: Multipart form data with image file

Get Products

GET /api/merchant/productos

Get Single Product

GET /api/merchant/productos/{id}

Process Checkout

POST /api/merchant/checkout

Request Body:

{
    "event_id": 1,
    "items": [
        {
            "product_id": 1,
            "variant_id": 1,
            "quantity": 2
        }
    ],
    "shipping_address": {
        "name": "John Doe",
        "address": "123 Main St",
        "city": "Madrid",
        "postal_code": "28001"
    }
}

Configuration API

Create Permission

POST /api/createPermission

Request Body:

{
    "name": "manage_events",
    "guard_name": "web"
}

Delete Permission

DELETE /api/permissions/{idPermission}

User Management API

Get User Profile

GET /user/profile

Update Profile

POST /user/update-profile

Request Body:

{
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+1234567890"
}

Update Password

POST /user/update-password

Request Body:

{
    "current_password": "oldpassword",
    "password": "newpassword",
    "password_confirmation": "newpassword"
}

Organization Management API

Get Organizations

GET /api/organizaciones

Create Organization

POST /api/organizaciones

Request Body:

{
    "name": "Sports Club",
    "email": "contact@sportsclub.com",
    "phone": "+1234567890",
    "address": "123 Sports Ave"
}

Update Organization

POST /api/organizaciones/{organizacionId}

Delete Organization

GET /api/organizaciones/delete/{organizacionId}

Export Organizations

GET /api/organizaciones/export-to-xls

Language Management API

Get Languages

GET /api/idiomas

Create Language

POST /administrar-idiomas

Request Body:

{
    "name": "English",
    "code": "en",
    "url_image": "/flags/en.png"
}

Update Language

POST /editar-idiomas

Delete Language

GET /api/idiomas-delete/{idiomaId}

Tariff Management API

Get Tariffs

GET /api/tarifas

Create Tariff

POST /api/tarifas

Request Body:

{
    "name": "Standard Registration",
    "description": "Standard event registration",
    "prices": [
        {
            "pricing": 50.00,
            "currency": "EUR"
        }
    ]
}

Update Tariff

POST /api/tarifas/{tarifaId}

Delete Tariff

GET /api/tarifas/delete/{tarifaId}

Models & Data Structures

Event Model

class Evento extends Model
{
    protected $fillable = [
        'name',
        'description',
        'ciudad',
        'pais',
        'pagina_web',
        'date_from',
        'date_to',
        'participants',
        'enrolled',
        'category',
        'date_from_register',
        'date_to_register',
        'facebook',
        'instagram',
        'phone_number',
        'x',
        'organizador_id',
        'created_by',
        'email',
        'latitude',
        'longitude',
        'address',
        'json_forms',
        'flag_active',
        'general_aspect',
        'url_image',
        'timezone'
    ];

    protected $casts = [
        'tarifas' => 'array',
        'general_aspect' => 'array',
        'date_from' => 'datetime',
        'date_to' => 'datetime',
        'date_from_register' => 'datetime',
        'date_to_register' => 'datetime',
        'json_maps' => 'array',
        'json_forms' => 'array',
    ];
}

User Model

class User extends Authenticatable
{
    protected $fillable = [
        'name',
        'email',
        'password',
        'organizador_id',
        'phone',
        'address'
    ];

    protected $hidden = [
        'password',
        'remember_token',
    ];
}

Event Registration Model

class EventoXUsuario extends Model
{
    protected $fillable = [
        'evento_id',
        'user_id',
        'tarifa_id',
        'status',
        'payment_status',
        'total_amount',
        'discount_amount'
    ];
}

Helper Functions

Status Management Functions

get_status_meta()

Returns status metadata including label and CSS class.

function get_status_meta($status_key = '')
{
    $metas = [
        'active' => [
            'label' => 'Active',
            'class' => 'success',
        ],
        'inactive' => [
            'label' => 'Inactive',
            'class' => 'warning',
        ],
        'blocked' => [
            'label' => 'Blocked',
            'class' => 'danger',
        ],
    ];

    if (empty($status_key)) {
        return $metas;
    }

    return $metas[$status_key] ?? [];
}

Usage:

$status = get_status_meta('active');
// Returns: ['label' => 'Active', 'class' => 'success']

get_status_class()

Returns CSS class for a status.

function get_status_class($status_key = '')
{
    $status_meta = get_status_meta($status_key);
    return $status_meta['class'] ?? '';
}

Usage:

$class = get_status_class('active');
// Returns: 'success'

get_status_label()

Returns human-readable label for a status.

function get_status_label($status_key = '')
{
    $status_meta = get_status_meta($status_key);
    return $status_meta['label'] ?? '';
}

Usage:

$label = get_status_label('active');
// Returns: 'Active'

Frontend Components

JavaScript Dependencies

The application uses several JavaScript libraries:

jQuery: DOM manipulation and AJAX requests
Bootstrap: UI framework
DataTables: Table functionality
Swiper: Carousel/slider functionality
Toastr: Notification system
Moment.js: Date/time manipulation
PDFMake: PDF generation
JSZip: File compression
Tabulator: Advanced table functionality

Key Frontend Features

DataTables Integration

// Initialize DataTable
$('#events-table').DataTable({
    processing: true,
    serverSide: true,
    ajax: '/api/eventos',
    columns: [
        { data: 'name' },
        { data: 'date_from_format' },
        { data: 'participants' },
        { data: 'actions' }
    ]
});

AJAX Form Submissions

// Submit form via AJAX
$.ajax({
    url: '/api/eventos',
    method: 'POST',
    data: formData,
    success: function(response) {
        toastr.success('Event created successfully');
        location.reload();
    },
    error: function(xhr) {
        toastr.error('Error creating event');
    }
});

File Uploads

// Upload product image
var formData = new FormData();
formData.append('image', fileInput.files[0]);
formData.append('product_id', productId);

$.ajax({
    url: '/api/merchant/catalogos/productos/uploadImage',
    method: 'POST',
    data: formData,
    processData: false,
    contentType: false,
    success: function(response) {
        toastr.success('Image uploaded successfully');
    }
});

Usage Examples

Creating an Event

// Using the API
$response = Http::post('/api/eventos', [
    'name' => 'Marathon 2024',
    'description' => 'Annual marathon event',
    'address' => 'Central Park, New York',
    'pagina_web' => 'https://marathon2024.com',
    'date_from' => '2024-06-15',
    'time_from' => '08:00',
    'date_to' => '2024-06-15',
    'time_to' => '18:00',
    'date_from_register' => '2024-05-01',
    'time_from_register' => '00:00',
    'date_to_register' => '2024-06-14',
    'time_to_register' => '23:59',
    'participants' => 1000,
    'create_latitude' => 40.7829,
    'create_longitude' => -73.9654,
    'timezone' => 'America/New_York'
]);

Processing a Payment

// Using the checkout API
$response = Http::post('/api/merchant/checkout', [
    'event_id' => 1,
    'items' => [
        [
            'product_id' => 1,
            'variant_id' => 1,
            'quantity' => 2
        ]
    ],
    'shipping_address' => [
        'name' => 'John Doe',
        'address' => '123 Main St',
        'city' => 'New York',
        'postal_code' => '10001'
    ]
]);

Managing Rankings

// Create a ranking
$response = Http::post('/events/1/rankings', [
    'name' => 'Overall Ranking',
    'description' => 'Overall event ranking based on finish time',
    'criteria' => [
        [
            'field' => 'finish_time',
            'weight' => 1.0,
            'order' => 'asc'
        ]
    ]
]);

// Recalculate rankings
$response = Http::post('/events/1/rankings/1/recalculate');

Sending Communications

// Send email to all participants
$response = Http::post('/api/eventos/communications/send-email', [
    'event_id' => 1,
    'subject' => 'Event Update - Important Information',
    'message' => 'Dear participants, please note the following updates...',
    'recipients' => ['all']
]);

Managing Merchandise

// Create a product catalog
$response = Http::post('/api/merchant/store', [
    'name' => 'Event Merchandise 2024',
    'description' => 'Official merchandise for the event',
    'event_id' => 1
]);

// Add products to catalog
$response = Http::post('/api/merchant/productos/store', [
    'catalog_id' => 1,
    'name' => 'Event T-Shirt',
    'description' => 'Comfortable cotton t-shirt',
    'price' => 25.00,
    'stock' => 100,
    'variants' => [
        [
            'attributes' => ['size' => 'M', 'color' => 'Blue'],
            'price' => 25.00,
            'stock' => 50
        ]
    ]
]);

Error Handling

Common HTTP Status Codes

200: Success
201: Created
400: Bad Request
401: Unauthorized
403: Forbidden
404: Not Found
422: Validation Error
500: Internal Server Error

Error Response Format

{
    "message": "The given data was invalid.",
    "errors": {
        "email": [
            "The email field is required."
        ],
        "password": [
            "The password field is required."
        ]
    }
}

Rate Limiting

The API implements rate limiting to prevent abuse. Limits are applied per user/IP address:

Authentication endpoints: 5 requests per minute
General API endpoints: 60 requests per minute
File upload endpoints: 10 requests per minute

Security Considerations

Authentication: All sensitive endpoints require authentication
Authorization: Role-based access control using Spatie Laravel Permission
CSRF Protection: Web forms include CSRF tokens
Input Validation: All inputs are validated using Laravel’s validation system
SQL Injection Protection: Uses Eloquent ORM with parameterized queries
XSS Protection: Output is properly escaped in Blade templates

Testing

API Testing Examples

// Test event creation
public function test_can_create_event()
{
    $user = User::factory()->create();
    
    $response = $this->actingAs($user)
        ->postJson('/api/eventos', [
            'name' => 'Test Event',
            'description' => 'Test Description',
            'date_from' => '2024-06-15',
            'participants' => 100
        ]);
    
    $response->assertStatus(201);
    $this->assertDatabaseHas('eventos', ['name' => 'Test Event']);
}

This documentation covers the main APIs, functions, and components of the event management system. For specific implementation details, refer to the individual controller and model files.

​Event Management System API Documentation

​Table of Contents

​Overview

​Key Features

​Authentication

​Sanctum Authentication

​Session Authentication

​API Endpoints

​Authentication Endpoints

​User Login

​User Registration

​Event Management API

​Get Events (Filtered)

​Create Event

​Update Event

​Get Event Forms

​Update Event Forms

​Checkout & Payment API

​Get Event Products

​Add Product to Cart

​Remove from Cart

​Get Product Variants

​Find Product Variant

​Rankings API

​Get Event Rankings

​Create Ranking

​Recalculate Rankings

​Export Rankings

​Discounts API

​Get Discounts

​Create Discount

​Update Discount

​Delete Discount

​Communications API

​Get Communications

​Send Communication

​Generate Report

​Merchandise API

​Get Catalogs

​Create Catalog

​Update Catalog

​Delete Catalog

​Upload Product Image

​Get Products

​Get Single Product

​Process Checkout

​Configuration API

​Create Permission

​Delete Permission

​User Management API

​Get User Profile

​Update Profile

​Update Password

​Organization Management API

​Get Organizations

​Create Organization

​Update Organization

​Delete Organization

​Export Organizations

​Language Management API

​Get Languages

​Create Language

​Update Language

​Delete Language

​Tariff Management API

​Get Tariffs

​Create Tariff

​Update Tariff

​Delete Tariff

​Models & Data Structures

​Event Model

​User Model

​Event Registration Model

​Helper Functions

​Status Management Functions

​get_status_meta()

​get_status_class()

​get_status_label()

​Frontend Components

​JavaScript Dependencies

Event Management System API Documentation

Table of Contents

Overview

Key Features

Authentication

Sanctum Authentication

Session Authentication

API Endpoints

Authentication Endpoints

User Login

User Registration

Event Management API

Get Events (Filtered)

Create Event

Update Event

Get Event Forms

Update Event Forms

Checkout & Payment API

Get Event Products

Add Product to Cart

Remove from Cart

Get Product Variants

Find Product Variant

Rankings API

Get Event Rankings

Create Ranking

Recalculate Rankings

Export Rankings

Discounts API

Get Discounts

Create Discount

Update Discount

Delete Discount

Communications API

Get Communications

Send Communication

Generate Report

Merchandise API

Get Catalogs

Create Catalog

Update Catalog

Delete Catalog

Upload Product Image

Get Products

Get Single Product

Process Checkout

Configuration API

Create Permission

Delete Permission

User Management API

Get User Profile

Update Profile

Update Password

Organization Management API

Get Organizations

Create Organization

Update Organization

Delete Organization

Export Organizations

Language Management API

Get Languages

Create Language

Update Language

Delete Language

Tariff Management API

Get Tariffs

Create Tariff

Update Tariff

Delete Tariff

Models & Data Structures

Event Model

User Model

Event Registration Model

Helper Functions

Status Management Functions

get_status_meta()

get_status_class()

get_status_label()

Frontend Components

JavaScript Dependencies