Colección de Postman

El portal expone una colección de Postman (formato v2.1.0) generada automáticamente desde el openapi.yaml. Cada vez que se construye el sitio, la colección se regenera — siempre está sincronizada con la referencia.

Descargar

Importar en Postman

1. En Postman: File → Import (o Ctrl+O).
2. Arrastra los dos archivos JSON descargados.
3. Selecciona el environment ClickBalance Local en el dropdown de la esquina superior derecha.
4. Listo.

Flujo de uso

1. Login (auto-token)

Abre la carpeta Auth → Obtener Bearer token y dale a Send. El body ya viene rellenado con {{usuario}} y {{password}}, que toman su valor del environment (default: cb / 1234).

El test script del request captura el token de la respuesta y lo guarda en la variable de colección {{token}}. Lo verás en la consola de Postman:

[ClickBalance] Token guardado en {{token}}. Expira: 2026-04-29T21:32:31

2. Cualquier otro request

La colección tiene Bearer auth a nivel raíz con {{token}} — todos los demás endpoints lo heredan. No tienes que copiar/pegar el token a mano.

3. Editar variables

Para apuntar a otro entorno (staging, producción) o cambiar credenciales:

• Variables del environment (recomendado): clic en el ícono del ojo arriba a la derecha → Edit. Modifica baseUrl, usuario, password.
• Variables de colección: clic en la colección → Variables. Útil si compartes la colección sin el environment.

Variables disponibles

El environment descargable trae usuario, password y token vacíos por diseño — el environment es para datos personales/por entorno, no para los defaults de demo.

Folders

La colección está organizada por los tags del OpenAPI:

• Auth (5 endpoints) — login, refresh, logout, permissions, invalidate.
• Metadata (2 endpoints) — list models, get model metadata. No requieren token.
• CRUD (5 endpoints) — list, get, create, update, delete con {modelo} y {id} como path variables.

Regenerar la colección

Si actualizas el openapi.yaml, la colección se regenera al construir:

pnpm sync:openapi    # extrae el spec de genia-connector
pnpm build:postman   # regenera solo la colección
# o
pnpm build           # corre prebuild que incluye la colección

Limitaciones conocidas

• Los Business Actions (POST /{modelo}/actions/{accion}) no están en la colección porque aún no aparecen en el openapi.yaml. Por ahora invócalos manualmente o copia un endpoint CRUD y ajusta el path.
• Los ejemplos de body en CRUD son los del OpenAPI (campos genéricos). Para cada modelo concreto, consulta GET /metadata/{modelo} para ver los campos reales.