Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jparra-amell/api_solsql/llms.txt

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

This guide walks you through running SolSQL API locally, authenticating as a user, and fetching your first list of places. By the end you will have a working base URL, a valid login response, and a list of place summaries returned from the API.
1

Start the API server

Run the API using Docker (see Deployment) or the .NET CLI. Once running, the server listens on port 8080.Verify the server is up by opening the Swagger UI in your browser:
http://localhost:8080/swagger
You should see the interactive API documentation listing all available endpoints.
2

Authenticate with the login endpoint

All protected operations require a valid user. Call POST /api/LoginRequest/login with your email, password, and role number.
curl -X POST http://localhost:8080/api/LoginRequest/login \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"yourpassword","role":1}'
A successful response returns the authenticated user object with the Password field set to null:
{
  "Id": 42,
  "Name": "Jane Smith",
  "Email": "[email protected]",
  "Password": null,
  "Role": 1
}
If the email is not found, the role does not match, or the password is incorrect, the API returns 401 Unauthorized with a descriptive message.
Passwords are stored as BCrypt hashes. Always send the plain-text password in the request body — the API handles verification internally.
3

Fetch a summary list of places

Once you have confirmed the API is reachable and authentication works, call GET /api/Places/info_rapida to retrieve a summary list of all active places:
curl http://localhost:8080/api/Places/info_rapida
The response is a JSON array where each entry contains general information about a place of interest:
[
  {
    "place_id": 1,
    "name": "Parque Nacional",
    "type": "Park",
    "city": "Bogotá",
    "coordinates": "4.6097,-74.0817"
  }
]
Use GET /api/Places/buscar?busqueda=park to filter results by a search term, or GET /api/Places/{id}/detalle to retrieve full detail for a specific place.
4

Explore endpoints in Swagger UI

Navigate to http://localhost:8080/swagger to browse and test every endpoint interactively. Swagger UI lets you send requests directly from the browser without needing a separate HTTP client.

​
Next steps

Deploy with Docker

Build and run the API as a Docker container with your MySQL connection.

Authentication concepts

Understand how roles and BCrypt hashing work in the login flow.

Places API reference

Full endpoint documentation for place CRUD, search, and detail views.

API reference

Complete reference for every resource and endpoint in SolSQL API.

Build docs developers (and LLMs) love

Get started for freeTalk to us