Skip to content

Ambientes

A API FluxiQ NPC esta disponivel em tres ambientes distintos, cada um com caracteristicas especificas para diferentes fases do ciclo de desenvolvimento.

Visao Geral

AmbienteURL BaseAPI KeyDescricao
Localhttp://localhost:4000/api/v1/centralpk_test_*Desenvolvimento com simulador
Sandboxhttps://sandbox.pixconnect.com.br/api/v1/centralpk_test_*Testes e homologacao
Producaohttps://api.pixconnect.com.br/api/v1/centralpk_live_*Ambiente produtivo real

Ambiente Local

O ambiente local permite desenvolver e testar sua integracao usando o Nuclea Simulator, que simula todos os servicos da infraestrutura Nuclea sem dependencias externas.

Requisitos

RequisitoEspecificacao
DockerVersao 20.10 ou superior
Docker ComposeVersao 2.0 ou superior
Memoria RAMMinimo 4GB disponivel
Portas4000-4010 disponiveis
SistemaLinux, macOS ou Windows (WSL2)

Instalacao

Clone o repositorio e inicie o ambiente de desenvolvimento:

bash
# Clone o repositorio
git clone https://github.com/playersbet/pixconnect-nuclea.git
cd pixconnect-nuclea

# Inicie todos os servicos
docker-compose up -d

# Verifique se os servicos estao rodando
docker-compose ps

Servicos Disponiveis

O ambiente local executa os seguintes servicos:

ServicoPortaURLDescricao
Backend API4000http://localhost:4000API principal FluxiQ NPC
PCR Simulator4001http://localhost:4001Simula a Plataforma Centralizada de Recebiveis
Webhook Receiver4002http://localhost:4002Recebe webhooks para testes
FTP Server4003ftp://localhost:4003Simula FTP Nuclea para arquivos ACMP615
Orchestrator4005http://localhost:4005Orquestra cenarios de teste
Control Panel4010http://localhost:4010Interface web do simulador

Cenarios de Teste

O Nuclea Simulator permite simular diversos cenarios de teste atraves do Orchestrator:

Simular Pagamento de Boleto

bash
# Simula o pagamento de um boleto especifico
curl -X POST "http://localhost:4005/scenarios/payment" \
  -H "Content-Type: application/json" \
  -d '{
    "boleto_id": "uuid-do-boleto",
    "valor_pago": 15000,
    "data_pagamento": "2026-02-03"
  }'

Disparar Ciclo de Liquidacao

bash
# Dispara manualmente um ciclo de liquidacao
curl -X POST "http://localhost:4005/scenarios/settlement" \
  -H "Content-Type: application/json" \
  -d '{
    "cycle_type": "morning",
    "boleto_ids": ["uuid-1", "uuid-2"]
  }'

Simular Erro do PCR

bash
# Simula uma falha na comunicacao com o PCR
curl -X POST "http://localhost:4005/scenarios/pcr-error" \
  -H "Content-Type: application/json" \
  -d '{
    "error_type": "timeout",
    "duration_seconds": 30
  }'

Painel de Controle

Acesse http://localhost:4010 para visualizar:

  • Status de todos os servicos
  • Boletos registrados no simulador
  • Historico de pagamentos simulados
  • Logs de comunicacao PCR/FTP
  • Triggers manuais para cenarios de teste

Desenvolvimento Local

O ambiente local e ideal para desenvolvimento e depuracao. Use-o para testar novos recursos antes de validar no Sandbox.

Ambiente Sandbox

O Sandbox e um ambiente de homologacao que replica o comportamento de producao, mas com dados de teste e sem impacto financeiro real.

Caracteristicas

  • Dados isolados: Boletos e transacoes sao independentes de producao
  • Mesma API: Endpoints identicos ao ambiente de producao
  • Webhooks reais: Notificacoes enviadas para sua URL de teste
  • Ciclos programados: Liquidacao simulada nos mesmos horarios (08:30 e 16:30)
  • Sem custo: Requisicoes nao geram cobranca

Limitacoes

RecursoLimitacao
Requisicoes por minuto100 RPM
Boletos ativosMaximo 1.000 simultaneos
Retencao de dados30 dias
Valor maximo boletoR$ 10.000,00 (1.000.000 centavos)
WebhooksMaximo 3 retentativas

Dados de Teste

No Sandbox, utilize os seguintes dados para testes:

json
{
  "pagador": {
    "nome": "Usuario Teste Sandbox",
    "documento": "00000000000",
    "tipo_documento": "cpf"
  },
  "valor": 15000,
  "vencimento": "2026-03-15"
}

Dados Ficticios

Nunca use dados reais de clientes no ambiente Sandbox. Utilize apenas dados ficticios para testes.

Acesso ao Sandbox

  1. Solicite credenciais de sandbox pelo FluxiQ Portal
  2. Receba sua API Key com prefixo pk_test_
  3. Configure sua aplicacao para usar a URL do Sandbox
  4. Comece a testar!

Ambiente de Producao

O ambiente de producao processa transacoes financeiras reais e esta conectado a infraestrutura Nuclea oficial.

Caracteristicas

  • Transacoes reais: Boletos registrados oficialmente no PCR
  • Alta disponibilidade: SLA de 99.9%
  • Seguranca: Conexao mTLS com certificados Nuclea
  • Monitoramento: Alertas e metricas em tempo real
  • Suporte: Atendimento prioritario

Checklist Pre-Producao

Antes de migrar para producao, certifique-se de completar todos os itens:

Integracao

  • [ ] Testes completos no ambiente Sandbox
  • [ ] Tratamento de todos os codigos de erro
  • [ ] Implementacao de retentativas com backoff exponencial
  • [ ] Validacao de webhooks com assinatura HMAC

Seguranca

  • [ ] API Key de producao armazenada de forma segura
  • [ ] HTTPS obrigatorio em todas as comunicacoes
  • [ ] Logs sem dados sensiveis expostos
  • [ ] Webhook endpoint configurado com HTTPS

Operacional

  • [ ] Monitoramento de erros configurado
  • [ ] Alertas para falhas de integracao
  • [ ] Processo de rotacao de chaves documentado
  • [ ] Contato de suporte tecnico definido

Compliance

  • [ ] Politica de privacidade atualizada
  • [ ] Termos de uso revisados
  • [ ] LGPD compliance verificado

Solicitar Acesso

Para obter acesso ao ambiente de producao:

  1. Complete a homologacao no Sandbox
  2. Preencha o formulario de producao no FluxiQ Portal
  3. Aguarde a revisao da equipe (ate 5 dias uteis)
  4. Receba sua API Key de producao (pk_live_*)
  5. Configure o webhook de producao
  6. Inicie a operacao!

Ambiente Critico

O ambiente de producao processa transacoes financeiras reais. Teste exaustivamente no Sandbox antes de migrar.

Comparativo de Ambientes

CaracteristicaLocalSandboxProducao
DadosSimuladosTesteReais
Nuclea PCRSimuladorHomologacaoProducao
DisponibilidadeDev local99%99.9%
Rate LimitIlimitado100 RPM1000 RPM
WebhookslocalhostURLs publicasURLs publicas + HTTPS
SuporteDocumentacaoEmailPrioritario
CustoGratuitoGratuitoPor transacao

Proximos Passos

Documentação da API FluxiQ NPC