Proxies de API
Crie APIs, defina rotas e encaminhe tráfego para serviços upstream sem reescrever cada consumidor.
Visão geral
O que o API Manager cobre
O API Manager centraliza publicação de APIs, limites de consumo, políticas de tráfego, pipelines visuais de processamento, logs de execução e gestão de planos por tenant. A plataforma foi desenhada para equipes que precisam controlar quantas chamadas são feitas, com que frequência cada cliente pode usar a API e como os dados devem ser transformados no caminho.
Controle de uso e frequência
Aplique cotas de requisição, limites por minuto e regras de acesso baseadas no plano de cada tenant.
Área de testes
Use o API Explorer e o simulador de pipeline para validar payloads, headers e ramificações antes de publicar.
Vouchers de trial
Super-admins podem emitir vouchers com plano vinculado, janela de validade, limite de uso e período renovável de acesso.
Primeiros passos
Fluxo recomendado para começar
1
Crie um tenant
Cadastre-se normalmente ou use um voucher compartilhado por um super-admin. Quando o voucher é resgatado, o tenant recebe automaticamente o plano de trial e a data de expiração correspondente.
2
Crie um proxy de API
Acesse Dashboard > API Proxies e configure o destino upstream e as rotas de entrada.
3
Monte um pipeline
Abra Dashboard > Pipelines ou o editor visual, posicione um trigger, adicione políticas ou transformações e conecte um proxy ou mock.
4
Teste antes de expor
Adicione o simulador, envie headers, body e query params e revise os logs de execução no painel lateral.
5
Conecte o fluxo às requisições
Na configuração da API, associe um pipeline de pré-requisição ou pós-resposta para que a rota use a lógica visual em produção.
Gestão de APIs
Como organizar proxies, chaves e ambientes
Módulos principais
- API Proxies: definem paths de entrada, métodos e o destino upstream para encaminhamento.
- API Keys: emitem, rotacionam e desativam credenciais de acesso dos clientes.
- Environments: guardam valores diferentes para staging, sandbox e testes próximos de produção.
- Explorer: permite testar requisições manualmente antes ou depois de um pipeline ser associado.
- Observability e Logs: mostram latência, status codes e eventos por nó executado.
Cobrança e trials
Como os vouchers entram na gestão de planos
Regras dos vouchers
- Apenas o super-admin pode criar, editar, renovar, pausar ou estender vouchers.
- Cada voucher fica vinculado a um plano específico.
- O super-admin define um limite de usos, uma janela de resgate e a quantidade de dias de trial concedida após o resgate.
- Quando um voucher é resgatado, o tenant é atualizado com o plano do voucher e recebe uma data de validade final calculada a partir do período configurado.
- Renovar ou estender um voucher é feito editando status, limites, datas ou duração do trial no painel de super-admin.
Editor de Pipelines
Como o editor está organizado
Painel esquerdo: paleta de nós
Arraste os nós para o canvas ou clique para inseri-los imediatamente. Os grupos são divididos em gatilhos, processamento, políticas, destinos, utilitários, controle de fluxo e testes.
Centro: canvas visual
Conecte os nós em sequência. O editor suporta layouts horizontal e vertical, minimapa, zoom, importação, exportação e atalhos de teclado para copiar, recortar, colar e excluir.
Painel direito: inspetor
Selecione qualquer nó para editar seus campos. Quando o simulador roda, esse mesmo painel mostra o resultado da execução, a resposta e a linha do tempo de logs por nó.
Fundamentos do pipeline
Como começar um pipeline da forma correta
Estrutura inicial recomendada: HTTP Trigger -> Auth Check -> Rate Limit -> Transform ou Filter -> Proxy / Forward -> Log
- Comece com HTTP Trigger para que o fluxo tenha contexto da requisição desde o primeiro passo.
- Posicione Auth Check e Rate Limit cedo no fluxo para barrar violações antes de trabalho mais caro.
- Use Transform ou Filter para moldar o payload ou rejeitar entradas inválidas.
- Escolha Proxy / Forward para tráfego real ou Mock Response para testes e demonstrações.
- Adicione Log após transições importantes para que a observabilidade mostre onde o fluxo teve sucesso, falha ou desvio.
Referência
O que cada nó faz
webhookInício
HTTP Trigger
Inicia o pipeline e captura método, URL, headers e body da requisição de entrada.
Quando usar: Use sempre como primeiro nó de produção quando o fluxo reagir a uma chamada HTTP.
Campos principais: Métodos permitidos, Path pattern.
lockPolítica
Auth Check
Valida se a requisição carrega as informações de autenticação esperadas antes de continuar.
Quando usar: Posicione no começo da cadeia quando o pipeline precisar bloquear acessos não autorizados antes de chamar o upstream.
Campos principais: Scheme, Header name, JWT secret / key, Custom validator.
speedPolítica
Rate Limit
Aplica controle de frequência para impedir que o mesmo cliente ultrapasse o orçamento de chamadas permitido.
Quando usar: Adicione após a autenticação quando os limites dependerem de API key, usuário, header ou IP.
Campos principais: Max requests / minute, Key by, Header name, Reject status.
transformProcessamento
Transform
Altera a estrutura do payload de request ou response antes que o próximo nó receba os dados.
Quando usar: Use para normalizar payloads, mapear campos, remover ruído ou adaptar um contrato ao outro.
Campos principais: Expression, Input field, Output field.
filter_altProcessamento
Filter
Avalia uma condição e pode rejeitar ou ignorar tráfego que não deve prosseguir.
Quando usar: Bom para regras de negócio, validação rápida e proteção antes do proxy.
Campos principais: Condition, Reject status, Reject message.
account_treeControle de fluxo
Condition
Divide o fluxo em múltiplas saídas além de um caminho automático de else.
Quando usar: Use quando a próxima ação depender de status, headers, flags do tenant ou valores do payload.
Campos principais: Label, Branches, Expression per branch, Else fallback.
databasePolítica
Cache
Armazena respostas por um período para reaproveitar o mesmo resultado em chamadas repetidas.
Quando usar: Use antes do proxy ou após transformações pesadas quando a resposta puder ser reutilizada com segurança.
Campos principais: TTL, Cache key expression, Vary headers.
sendDestino
Proxy / Forward
Chama a URL de destino upstream e transforma o pipeline em um ponto real de integração.
Quando usar: Use quando o pipeline precisa encaminhar tráfego para outra API ou serviço.
Campos principais: Target URL, Method override, Extra headers, Timeout.
codeDestino
Mock Response
Retorna uma resposta sintética sem chamar um sistema upstream.
Quando usar: Ideal para demos, testes, fallback e rollout incremental antes de o backend real estar pronto.
Campos principais: HTTP status, Content-Type, Response body, Delay.
receipt_longUtilitário
Log
Grava entradas contextuais no log de execução usando o nível de log do pipeline.
Quando usar: Coloque em pontos importantes como antes do proxy, após decisões de branch ou depois da geração da resposta.
Campos principais: Level, Message template, Include body.
scienceTestes
Simulator
Nó apenas para testes que injeta método, path, headers, body e variáveis em uma execução do pipeline.
Quando usar: Use um único simulador durante o desenho ou debug do fluxo. Ele é ignorado em produção.
Campos principais: Method, Path, Query params, Headers, Request body, Context variables.
Uso nas requisições
Como usar pipelines em chamadas reais de API
- Crie ou edite uma API em Dashboard > API Proxies.
- Abra a configuração da rota e selecione um pipeline de pré-requisição quando precisar de lógica antes da chamada ao upstream.
- Selecione um pipeline de pós-resposta quando precisar transformar ou ramificar depois que o upstream responder.
- Salve a rota e teste em API Explorer ou no simulador visual primeiro.
- Monitore o resultado em Logs e Observability para confirmar o comportamento de cada nó.
Exemplo de encadeamento da requisição: Requisição do cliente -> Rota do API Proxy -> Pipeline de pré-requisição -> Serviço upstream -> Pipeline de pós-resposta -> Resposta final para o cliente
Exemplos
Três exemplos práticos de pipeline
1. Proxy protegido com controle de frequência
Use quando a API precisa rejeitar tráfego não autorizado e limitar rajadas do mesmo consumidor.
HTTP Trigger -> Auth Check -> Rate Limit -> Proxy / Forward -> Log
2. Normalização de payload antes do encaminhamento
Use quando o cliente envia um schema, mas o serviço upstream espera outra estrutura de campos.
HTTP Trigger -> Transform -> Filter -> Proxy / Forward -> Log
3. Fallback condicional com mock response
Use quando o fluxo deve seguir para uma branch no sucesso e devolver um fallback controlado em falha ou incompatibilidade.
HTTP Trigger
-> Proxy / Forward
-> Condition
-> branch: status === 200 -> Log
-> else -> Mock Response