Saltar al contenido principal

Colección Postman

La colección Postman de Ozzie incluye todos los endpoints de la API con ejemplos de solicitudes y respuestas pre-llenados. Está organizada en la misma secuencia que el flujo de integración recomendado, para que puedas ejecutar un onboarding completo de usuario, generación de plan y sesión de chat sin escribir ningún código.

Descarga​

Descargar la colección Postman

La colección es un archivo JSON estándar de Postman v2.1. Incluye todos los endpoints de la versión actual de la API.

Importando en Postman​

  1. Abre Postman
  2. Haz clic en Import en la esquina superior izquierda
  3. Selecciona File y elige el ozzie-api.postman_collection.json descargado
  4. Haz clic en Import

La colección aparecerá en tu barra lateral izquierda en Collections como Ozzie API.

tip

Después de importar, también importa el Ozzie API Environment para pre-configurar todas las variables. Descárgalo en: https://api.ozzieapp.com/postman/ozzie-api.postman_environment.json

Configurando variables de entorno​

La colección usa tres variables de entorno que debes configurar antes de hacer solicitudes:

VariableDescripciónValor de ejemplo
BASE_URLURL base de la API de Ozziehttps://api.ozzieapp.com/v1
TOKENTu client_id:client_secret codificado en base64ozp_Y2xpZW50X2ExYjJjM2Q0...
USER_IDEl ID de usuario de Ozzie a usar en los parámetros de rutausr_4f8a1b2c3d

Para generar el valor TOKEN, codifica en base64 tu client_id:client_secret:

echo -n "ozz_client_a1b2c3d4:sk_live_xK9mP2qR7tL..." | base64

Estructura de la colección​

La colección está organizada en la secuencia recomendada del flujo de la API:

Ozzie API
├── 1. Usuarios
│   ├── Crear usuario (POST /users)
│   └── Obtener usuario (GET /users/{user_id})
├── 2. Intake Financiero
│   ├── Enviar intake (POST /users/{user_id}/financial-intake)
│   └── Obtener intake (GET /users/{user_id}/financial-intake)
├── 3. Transacciones
│   ├── Enviar transacción de texto
│   ├── Enviar transacción de imagen
│   └── Listar transacciones
├── 4. Metas
│   ├── Establecer meta (POST /users/{user_id}/goals)
│   └── Obtener meta (GET /users/{user_id}/goals)
├── 5. Plan
│   ├── Generar plan (POST /users/{user_id}/plan)
│   └── Personalizar plan (POST /users/{user_id}/plan/personalize)
├── 6. Money Moves
│   ├── Generar ciclo (POST /users/{user_id}/money-moves/generate)
│   ├── Listar ciclos (GET /users/{user_id}/money-moves)
│   ├── Obtener ciclo (GET /users/{user_id}/money-moves/{move_id})
│   └── Actualizar estado del ciclo (PATCH /users/{user_id}/money-moves/{move_id})
└── 7. Chat
    └── Enviar mensaje (POST /users/{user_id}/chat/messages)

Ejecutando la colección completa​

Usa el Collection Runner de Postman para ejecutar todas las solicitudes en secuencia:

  1. Haz clic derecho en la colección Ozzie API
  2. Haz clic en Run collection
  3. Establece Iterations en 1
  4. Marca Save responses
  5. Haz clic en Run Ozzie API

Pruebas automatizadas con Newman​

La colección puede ejecutarse en CI/CD usando Newman, el runner de línea de comandos de Postman:

# Instalar Newman
npm install -g newman

# Ejecutar la colección
newman run ozzie-api.postman_collection.json \
  --environment ozzie-api.postman_environment.json \
  --reporters cli,junit \
  --reporter-junit-export results.xml