Novedades

Swagger UI en TuRuc: Explorá la API de forma interactiva

Sebastian Alvarez
Sebastian Alvarez
seb5433  ·  LinkedIn  · Publicado 29 ene 2024 · 2 min lectura

Una de las cosas que más nos pidieron desde el lanzamiento fue una forma de explorar la API sin tener que leer documentación estática. A partir de hoy, TuRuc tiene Swagger UI integrado.

¿Qué es Swagger UI?

Swagger UI es una interfaz visual e interactiva que muestra todos los endpoints disponibles en una API REST. Te permite ver qué parámetros acepta cada endpoint, qué devuelve, y lo más importante: probarlo directamente desde el navegador sin necesidad de Postman, curl ni ninguna herramienta externa.

¿Cómo acceder?

Podés abrir el Swagger de TuRuc desde cualquier navegador:

Abrir Swagger UI

Endpoints disponibles

En el Swagger vas a encontrar todos los endpoints de la API de TuRuc:

  • GET /api/contribuyente/{ruc} — consulta un RUC específico por número
  • GET /api/contribuyente/search — búsqueda por nombre o razón social (paginada)
  • GET /api/contribuyente/table — formato DataTables para integración con tablas
  • GET /api/contribuyente/persona-juridica — datos extendidos de personas jurídicas
  • GET /api/contribuyente/entidad-publica — datos de entidades públicas

Para cada endpoint podés ver los parámetros que acepta, los códigos de respuesta posibles y el schema del JSON que devuelve. Y podés ejecutarlo directamente con el botón "Try it out".

Para desarrolladores

Si estás integrando TuRuc en tu sistema, el Swagger es el punto de partida ideal. También tenemos documentación completa y librerías oficiales para Python, Java y JavaScript.