Coleção Postman

A coleção Postman da Ozzie inclui todos os endpoints da API com exemplos de requisições e respostas pré-preenchidos. Está organizada na mesma sequência que o fluxo de integração recomendado, para que você possa executar um onboarding completo de usuário, geração de plano e sessão de chat sem escrever nenhum código.

---

Download

Baixar a coleção Postman

A coleção é um arquivo JSON Postman v2.1 padrão. Inclui todos os endpoints da versão atual da API.

---

Importando no Postman

1. Abra o Postman
2. Clique em Import no canto superior esquerdo
3. Selecione File e escolha o ozzie-api.postman_collection.json baixado
4. Clique em Import

A coleção aparecerá na sua barra lateral esquerda em Collections como Ozzie API.

dica

Após importar, também importe o Ozzie API Environment para pré-configurar todas as variáveis. Baixe em: https://api.ozzieapp.com/postman/ozzie-api.postman_environment.json

---

Configurando variáveis de ambiente

A coleção usa três variáveis de ambiente que você deve configurar antes de fazer requisições:

Variável	Descrição	Valor de exemplo
BASE_URL	URL base da API Ozzie	https://api.ozzieapp.com/v1
TOKEN	Seu client_id:client_secret codificado em base64	ozp_Y2xpZW50X2ExYjJjM2Q0...
USER_ID	O ID de usuário Ozzie a usar nos parâmetros de caminho	usr_4f8a1b2c3d

Para gerar o valor TOKEN, codifique em base64 seu client_id:client_secret:

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

---

Estrutura da coleção

A coleção está organizada na sequência recomendada do fluxo da API:

Ozzie API
├── 1. Usuários
│   ├── Criar usuário (POST /users)
│   └── Buscar usuário (GET /users/{user_id})
├── 2. Intake Financeiro
│   ├── Enviar intake (POST /users/{user_id}/financial-intake)
│   └── Buscar intake (GET /users/{user_id}/financial-intake)
├── 3. Transações
│   ├── Enviar transação de texto
│   ├── Enviar transação de imagem
│   └── Listar transações
├── 4. Metas
│   ├── Definir meta (POST /users/{user_id}/goals)
│   └── Buscar meta (GET /users/{user_id}/goals)
├── 5. Plano
│   ├── Gerar plano (POST /users/{user_id}/plan)
│   └── Personalizar plano (POST /users/{user_id}/plan/personalize)
├── 6. Money Moves
│   ├── Gerar ciclo (POST /users/{user_id}/money-moves/generate)
│   ├── Listar ciclos (GET /users/{user_id}/money-moves)
│   ├── Buscar ciclo (GET /users/{user_id}/money-moves/{move_id})
│   └── Atualizar status do ciclo (PATCH /users/{user_id}/money-moves/{move_id})
└── 7. Chat
    └── Enviar mensagem (POST /users/{user_id}/chat/messages)

---

Executando a coleção completa

Use o Collection Runner do Postman para executar todas as requisições em sequência:

1. Clique com o botão direito na coleção Ozzie API
2. Clique em Run collection
3. Defina Iterations para 1
4. Marque Save responses
5. Clique em Run Ozzie API

---

Testes automatizados com Newman

A coleção pode ser executada em CI/CD usando o Newman, o runner de linha de comando do Postman:

# Instalar Newman
npm install -g newman

# Executar a coleção
newman run ozzie-api.postman_collection.json \
  --environment ozzie-api.postman_environment.json \
  --reporters cli,junit \
  --reporter-junit-export results.xml

# Exemplo: passo do GitHub Actions
- name: Run Ozzie API tests
  run: |
    newman run ozzie-api.postman_collection.json \
      --environment ozzie-api.postman_environment.json \
      --reporters cli,junit \
      --reporter-junit-export test-results.xml
  env:
    OZZIE_TOKEN: ${{ secrets.OZZIE_TOKEN }}