Skip to main content

Quickstart

This guide will help you make your first API calls to the Sistema de Gestión de Propiedades API. The API is live at https://idforideas-1.jamrdev.com.ar.

Base URL

https://idforideas-1.jamrdev.com.ar

List All Properties

The simplest way to get started is to fetch all properties. This endpoint is public and doesn’t require authentication.
curl https://idforideas-1.jamrdev.com.ar/api/propiedades

Response

You’ll receive an array of property objects:
[
  {
    "codigo_id": "ZN1001",
    "pais": "Argentina",
    "ciudad": "Tigre",
    "direccion": "Av. Cazón 123",
    "ambientes": 3,
    "metros_cuadrados": 75.5,
    "precio": 120000,
    "tipo_contratacion": "Venta",
    "estado": "Disponible",
    "descripcion": "Hermosa vista al río",
    "fecha_publicacion": "2024-03-04"
  }
]

Get a Specific Property

To retrieve details about a specific property, use its codigo_id:
curl https://idforideas-1.jamrdev.com.ar/api/propiedades/ZN1001

Response

{
  "codigo_id": "ZN1001",
  "pais": "Argentina",
  "ciudad": "Tigre",
  "direccion": "Av. Cazón 123",
  "ambientes": 3,
  "metros_cuadrados": 75.5,
  "precio": 120000,
  "tipo_contratacion": "Venta",
  "estado": "Disponible",
  "descripcion": "Hermosa vista al río",
  "fecha_publicacion": "2024-03-04"
}
If the property doesn’t exist, you’ll receive a 404 Not Found response.

Create a Property (Admin Only)

To create, update, or delete properties, you need to authenticate using HTTP Basic Auth.
This endpoint requires authentication. See the Authentication guide for setup instructions.
curl -X POST https://idforideas-1.jamrdev.com.ar/api/propiedades \
  -H "Authorization: Basic <your-base64-credentials>" \
  -H "Content-Type: application/json" \
  -d '{
    "pais": "Argentina",
    "ciudad": "Buenos Aires",
    "direccion": "Av. Corrientes 1234",
    "ambientes": 2,
    "metros_cuadrados": 65,
    "precio": 95000,
    "tipo_contratacion": "Alquiler",
    "estado": "Disponible",
    "descripcion": "Departamento luminoso en el centro"
  }'

Response

{
  "success": true,
  "message": "Propiedad creada correctamente",
  "id": "A7K92M"
}
The codigo_id is optional. If you don’t provide it, the API will generate a unique 6-character alphanumeric ID automatically.

Explore the Interactive Documentation

The API includes an interactive Swagger UI where you can test endpoints directly in your browser:
https://idforideas-1.jamrdev.com.ar/ui
The OpenAPI specification is also available in JSON format:
https://idforideas-1.jamrdev.com.ar/doc

Next Steps

Authentication

Learn how to set up Basic Auth for admin operations

Creating Properties

Detailed guide on creating properties

Updating Properties

Learn how to update property information

API Reference

Complete API reference documentation

Common Response Codes

Status CodeDescription
200 OKRequest successful
201 CreatedResource created successfully
400 Bad RequestInvalid request data or validation error
401 UnauthorizedMissing or invalid authentication credentials
404 Not FoundResource not found
409 ConflictResource already exists (duplicate codigo_id)
For detailed error handling strategies, check out the Error Handling guide.

Build docs developers (and LLMs) love