🏠 Início / 📚 Documentação / Guias De Uso / Guia Uso Ecossistema

Guia Uso Ecossistema

🚀 Guia Completo: Como Usar o Ecossistema C-Suite

Data: 2025-12-06
Versão: 1.0

📋 Índice

  1. Visão Geral
  2. Acesso ao Ecossistema
  3. Autenticação
  4. Dashboard Unificado
  5. Serviços Principais
  6. APIs e Endpoints
  7. Exemplos Práticos
  8. Ferramentas de Observabilidade
  9. Troubleshooting

🎯 Visão Geral

O C-Suite é um ecossistema unificado de gestão empresarial que integra múltiplos serviços sob um único domínio (csuite.internut.com.br).

Arquitetura

┌─────────────────────────────────────────────────┐
│         Gateway Unificado                        │
│    https://csuite.internut.com.br                │
└─────────────────────────────────────────────────┘
                    │
        ┌───────────┼───────────┐
        │           │           │
    ┌───▼───┐  ┌───▼───┐  ┌───▼───┐
    │ Auth  │  │  4C   │  │ C-Suite│
    │       │  │       │  │ Services│
    └───────┘  └───────┘  └───────┘

Componentes Principais

🌐 Acesso ao Ecossistema

URL Principal

Gateway Unificado:

https://csuite.internut.com.br

URLs dos Serviços

Serviço URL Descrição
Gateway https://csuite.internut.com.br Dashboard unificado
Auth https://csuite.internut.com.br/auth Autenticação
4C UI https://csuite.internut.com.br/4c Interface 4 Certos
4C Decision https://csuite.internut.com.br/4c/decision API de Decisão
Context https://csuite.internut.com.br/context Gestão de Contexto
Executive https://csuite.internut.com.br/executive Dashboard Executivo
Cashflow https://csuite.internut.com.br/cashflow Gestão Financeira
Sales Manager https://csuite.internut.com.br/sales-manager Gestão de Vendas

Ferramentas de Observabilidade

Ferramenta URL Descrição
Grafana https://grafana.internut.com.br Dashboards e métricas
Prometheus https://prometheus.internut.com.br Métricas e alertas
Kibana https://kibana.internut.com.br Logs centralizados
Portainer https://portainer.internut.com.br Gestão Docker

🔐 Autenticação

1. Login

Endpoint:

POST https://csuite.internut.com.br/auth/login

Request:

{
  "email": "usuario@example.com",
  "password": "senha123"
}

Response:

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "bearer",
  "expires_in": 3600,
  "user": {
    "id": 1,
    "email": "usuario@example.com",
    "level": 3
  }
}

2. Usar Token

Headers:

Authorization: Bearer <access_token>

Exemplo:

curl -X GET https://csuite.internut.com.br/auth/me \
  -H "Authorization: Bearer <access_token>"

3. Refresh Token

Endpoint:

POST https://csuite.internut.com.br/auth/refresh

Request:

{
  "refresh_token": "eyJhbGciOiJIUzI1NiIs..."
}

4. Logout

Endpoint:

POST https://csuite.internut.com.br/auth/logout

Headers:

Authorization: Bearer <access_token>

📊 Dashboard Unificado

Acessar Dashboard

  1. Acesse: https://csuite.internut.com.br
  2. Faça login (se necessário)
  3. Visualize todos os serviços disponíveis

Funcionalidades

🛠️ Serviços Principais

1. 4C (4 Certos)

Sistema de Decisão Inteligente

4C UI

4C Decision API

Endpoints principais:
- POST /decide - Tomar decisão
- POST /decide/auto - Decisão automática
- POST /send - Enviar decisão
- GET /health - Health check

Exemplo:

curl -X POST https://csuite.internut.com.br/4c/decision/decide \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "customer_id": 123,
    "context": {
      "channel": "whatsapp",
      "product": "SKU-123"
    }
  }'

2. C-Suite Executive

Dashboard Executivo

3. C-Suite Context

Gestão de Contexto

API:
- URL: https://csuite.internut.com.br/context/api/csuite
- Documentação: https://csuite.internut.com.br/context/api/csuite/docs

4. C-Suite Cashflow

Gestão Financeira

API:
- URL: https://csuite.internut.com.br/cashflow/api/cashflow
- Documentação: https://csuite.internut.com.br/cashflow/api/cashflow/docs

5. C-Suite Sales Manager

Gestão de Vendas

📡 APIs e Endpoints

Estrutura de URLs

Todos os serviços seguem o padrão:

https://csuite.internut.com.br/<servico>/api/<versao>

Documentação OpenAPI

Cada serviço expõe documentação Swagger/OpenAPI:

Rate Limiting

💡 Exemplos Práticos

Exemplo 1: Autenticação e Acesso a API

# 1. Login
TOKEN=$(curl -X POST https://csuite.internut.com.br/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "usuario@example.com",
    "password": "senha123"
  }' | jq -r '.access_token')

# 2. Usar token para acessar API protegida
curl -X GET https://csuite.internut.com.br/context/api/csuite/agents \
  -H "Authorization: Bearer $TOKEN"

Exemplo 2: Tomar Decisão com 4C

curl -X POST https://csuite.internut.com.br/4c/decision/decide \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "customer_id": 123,
    "context": {
      "channel": "whatsapp",
      "product": "SKU-123",
      "urgency": "high"
    }
  }'

Exemplo 3: Obter Features de Cliente

curl -X POST https://csuite.internut.com.br/4c/feature-service/features/customer \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": 123,
    "context": {}
  }'

Exemplo 4: Health Check de Todos os Serviços

# Via Gateway
curl https://csuite.internut.com.br/health

# Serviços individuais
curl https://csuite.internut.com.br/auth/health
curl https://csuite.internut.com.br/4c/decision/health
curl https://csuite.internut.com.br/context/api/csuite/health

📈 Ferramentas de Observabilidade

1. Grafana

Acesso: https://grafana.internut.com.br

Funcionalidades:
- Dashboards de métricas
- Alertas configuráveis
- Visualizações customizadas

Dashboards Disponíveis:
- Métricas de serviços
- Performance de APIs
- Uso de recursos
- Métricas de negócio

2. Prometheus

Acesso: https://prometheus.internut.com.br

Funcionalidades:
- Coleta de métricas
- Queries PromQL
- Alertas

Exemplo de Query:

# Requisições por segundo
rate(http_requests_total[5m])

# Latência P95
histogram_quantile(0.95, rate(http_request_duration_seconds_bucket[5m]))

3. Kibana

Acesso: https://kibana.internut.com.br

Funcionalidades:
- Busca de logs
- Visualizações
- Dashboards de logs

Data View: csuite-logs-*

Queries Úteis:

# Erros do csuite-auth
service_name: "csuite-auth" and log_level: "ERROR"

# Logs do Traefik
container.image.name: traefik*

# Buscar timeouts
*timeout*

4. Portainer

Acesso: https://portainer.internut.com.br

Funcionalidades:
- Gestão de containers Docker
- Visualização de serviços
- Logs em tempo real
- Gestão de volumes e networks

🔧 Troubleshooting

Problema: 401 Unauthorized

Causa: Token inválido ou expirado

Solução:
1. Verificar se token está correto
2. Fazer refresh do token
3. Fazer novo login

# Refresh token
curl -X POST https://csuite.internut.com.br/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{"refresh_token": "<refresh_token>"}'

Problema: 404 Not Found

Causa: URL incorreta ou serviço não disponível

Solução:
1. Verificar URL correta no dashboard
2. Verificar health check do serviço
3. Verificar logs do serviço

# Verificar health
curl https://csuite.internut.com.br/health

# Ver logs (via Portainer ou Docker)
docker service logs <servico> --tail 50

Problema: 429 Too Many Requests

Causa: Rate limit excedido

Solução:
1. Aguardar reset do rate limit
2. Usar autenticação para limites maiores
3. Implementar retry com backoff

Problema: Serviço Indisponível

Causa: Serviço em restart ou erro

Solução:
1. Verificar status no Portainer
2. Verificar logs do serviço
3. Verificar métricas no Grafana
4. Verificar alertas configurados

# Ver status
docker service ls | grep <servico>

# Ver logs
docker service logs <servico> --tail 100

# Ver métricas (via Prometheus)
curl "https://prometheus.internut.com.br/api/v1/query?query=up{job=\"<servico>\"}"

📚 Recursos Adicionais

Documentação

Scripts Úteis

🎯 Fluxos Comuns

Fluxo 1: Autenticação e Acesso a API

1. Login → Obter token
2. Usar token em requisições
3. Refresh token quando expirar
4. Logout quando necessário

Fluxo 2: Tomar Decisão com 4C

1. Obter features do cliente
2. Chamar Decision API
3. Receber decisão (oferta, canal, timing)
4. Executar ação
5. Coletar feedback

Fluxo 3: Monitoramento

1. Acessar Grafana para métricas
2. Acessar Kibana para logs
3. Verificar alertas
4. Investigar problemas

✅ Checklist de Uso

Primeiro Acesso

Uso Diário

Manutenção

🆘 Suporte

Em Caso de Problemas

  1. Verificar logs: Kibana ou Portainer
  2. Verificar métricas: Grafana
  3. Verificar health checks: Gateway dashboard
  4. Consultar documentação: docs/
  5. Verificar troubleshooting: docs/TROUBLESHOOTING.md

Última atualização: 2025-12-06

🔊 Text-to-Speech

1.0x
1.0
Pronto para reproduzir