Endpoints

Todos los endpoints disponibles en el plan Gratuito

GET /api/v1/catalogs

Obtiene la lista de todos los catálogos disponibles.

Respuesta

{
  "success": true,
  "data": [
    {
      "slug": "c_FormaPago",
      "name": "Formas de Pago",
      "description": "Catálogo de formas de pago del SAT"
    }
  ]
}

GET /api/v1/catalogs/{slug}

Obtiene los datos de un catálogo específico con paginación.

Parámetros

Parámetro	Tipo	Descripción
`slug`	string	Identificador del catálogo
`page`	int	Número de página (default: 1)
`per_page`	int	Registros por página (default: 100, max: 1000)

Respuesta

{
  "success": true,
  "catalog": "c_FormaPago",
  "data": [...],
  "pagination": {
    "current_page": 1,
    "per_page": 100,
    "total_records": 500,
    "total_pages": 5,
    "has_more": true,
    "links": {
      "first": "/api/v1/catalogs/c_FormaPago?page=1",
      "last": "/api/v1/catalogs/c_FormaPago?page=5",
      "prev": null,
      "next": "/api/v1/catalogs/c_FormaPago?page=2"
    }
  }
}

GET /api/v1/search

Busca registros dentro de un catálogo específico.

Parámetros

Parámetro	Tipo	Descripción
`catalog`	string	Slug del catálogo (requerido)
`q`	string	Término de búsqueda (requerido)
`field`	string	Campo específico donde buscar (opcional)

Ejemplo

GET /api/v1/search?catalog=c_FormaPago&q=efectivo

GET /api/v1/me

Obtiene información del usuario autenticado y su uso de API.

Respuesta

{
  "success": true,
  "user": {
    "username": "john_doe",
    "email": "john@example.com",
    "role": "user",
    "daily_limit": 100
  },
  "usage": {
    "today": 45,
    "remaining": 55
  }
}