Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CodexaCP/SERVICIOS-BACK/llms.txt

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

ServiciosYa API is the backend REST service for a multi-tenant logistics and services platform. It provides JWT-authenticated endpoints for managing the full lifecycle of service requests — from catalog browsing and payment proof submission to manual payment validation, status transitions, and refund confirmation. The API also exposes system diagnostics and a structured audit trail.

Quickstart

Make your first authenticated API call in minutes

Core Concepts

Understand tenancy, roles, and the request lifecycle

API Reference

Full endpoint documentation with request and response schemas

Configuration

JWT, database, email, and diagnostics settings

What can you build?

ServiciosYa API is designed to be consumed by web portals and mobile apps. The Angular admin portal and the .NET MAUI Android app both talk exclusively to this API.

Service Catalog

Create, activate, and browse services by category

Service Requests

Submit requests with payment proofs and track status

Payments

Validate or reject payment proofs, confirm refunds

File Uploads

Upload payment proofs, attachments, and delivery docs

Audit Logs

Full structured audit trail on every operation

System Diagnostics

Live health, metrics, and error monitoring

How to get started

1

Set up the database

Run the SQL Server migrations in Database/Migrations/ against your EncomiendasDB instance. See Database Setup for the correct execution order.
2

Configure the API

Update appsettings.json (or environment variables) with your JWT key, connection string, and email settings. See Configuration.
3

Obtain a JWT token

Call POST /api/auth/login with valid credentials. Include the returned token as Authorization: Bearer <token> on every subsequent request.
4

Make your first call

Fetch the active service catalog at GET /api/services/available to confirm your token and company data are correctly resolved.
The API ships with Swagger UI enabled in the Development environment. Start the project locally and navigate to /swagger to explore all endpoints interactively.

Build docs developers (and LLMs) love