# Documentación Interactiva (Rapidocus)

La documentación interactiva es una herramienta integrada en la plataforma del Catálogo de Servicios que permite a los desarrolladores **explorar, probar y entender los endpoints del API** de manera visual e intuitiva, sin necesidad de instalar aplicaciones externas.

[![image.png](https://docs.digital.gob.do/uploads/images/gallery/2025-07/scaled-1680-/ngXlV49KaLe5IXTn-image.png)](https://docs.digital.gob.do/uploads/images/gallery/2025-07/ngXlV49KaLe5IXTn-image.png)

Esta sección proporciona un espacio donde cualquier usuario técnico puede aprender rápidamente cómo funciona el API, ver cómo se estructuran las llamadas y comprender de forma más profunda las respuestas y parámetros disponibles, reduciendo el tiempo de aprendizaje.

### ¿Qué es la documentación interactiva?

Es una interfaz dinámica disponible desde el panel del Catálogo que permite:

- Navegar por todos los endpoints del API organizados por categorías.
- Consultar descripciones, parámetros y respuestas de cada endpoint.
- Probar los endpoints directamente desde la interfaz (con un botón "Try"), utilizando tus credenciales y tokens válidos.
- Ver ejemplos de solicitudes y respuestas en tiempo real.
- Ajustar cómo se visualiza la información (filtros, formato de código, organización de secciones).

### ¿Cómo acceder?

1. Ingresa al panel del Catálogo con tus credenciales.
2. Dirígete a la URL **`/admin/rapidocus`**
3. Selecciona la categoría de endpoints que quieras explorar (por ejemplo, **`Services`**).

### Funciones principales

- **Exploración por categorías**: Los endpoints están organizados según los recursos del API, para facilitar la búsqueda.
- **Pruebas en vivo (Try)**: Permite ejecutar solicitudes GET, POST, PUT o DELETE directamente, utilizando tus tokens y parámetros, y ver la respuesta al instante.
- **Visualización personalizable**: Puedes cambiar la forma en que se presentan los resultados (código resaltado, JSON plano o estructurado, etc.).
- **Filtros avanzados**: Permite buscar endpoints o parámetros específicos con un cuadro de búsqueda.
- **Copiar ejemplos**: Incluye botones para copiar al portapapeles ejemplos de requests y respuestas.

### ¿Por qué usarla?

- Evita configurar herramientas externas como Postman para pruebas iniciales.
- Acelera el aprendizaje de cómo funciona cada endpoint y qué datos retorna.
- Facilita la depuración durante el desarrollo, ya que puedes confirmar rápidamente si el API está respondiendo como se espera.

### Recomendaciones de uso

- Siempre inicia sesión con un usuario válido antes de probar endpoints protegidos.
- Utiliza primero el entorno de **sandbox** para realizar pruebas, antes de interactuar con producción.
- Respeta los límites de consumo (SLA) al ejecutar múltiples pruebas.
- Para integraciones reales, utiliza la guía "Quick Start" y la referencia completa del API (OpenAPI) en combinación con esta herramienta.

<div id="bkmrk--1">---

</div>