Ir para o conteúdo

Mantis Public API

Esta documentação contempla dados para integração do Mantis 3.0.

Conteúdo

Secção Descrição
Autenticação Header x-api-key e regras de acesso
Limites de taxa Quotas por IP, pico global, HTTP 429 e Retry-After
Referência API Rotas GET sob /risks e /events

Limites de taxa

A API pública aplica dois limites independentes: um por endereço IP e outro de volume global na mesma instância. Ambos usam uma janela de um segundo (segundo de calendário no servidor).

Tabela de limites e comportamento

Limite Janela O que é medido Limiar Quando dispara Bloqueio / penalização HTTP Corpo e cabeçalhos
Por IP 1 segundo Pedidos HTTP por endereço IP de cliente Até 10 pedidos por segundo por IP são aceites A partir do 11.º pedido no mesmo segundo para esse IP Esse IP deixa de ter pedidos aceites durante 5 segundos (repetidos 429 até expirar o bloqueio) 429 JSON com detail explicativo; cabeçalho Retry-After com os segundos a aguardar
Global (instância) 1 segundo Todos os pedidos à API na mesma instância/processo Até 500 pedidos no segundo; o 501.º no mesmo segundo dispara o limite Pico de tráfego total nesse segundo Todos os clientes recebem 429 durante 60 segundos (bloqueio global) 429 JSON com detail; Retry-After (tipicamente 60 segundos)

Notas importantes

  • Retry-After: indica quantos segundos deve esperar antes de voltar a chamar a API; respeitar este valor reduz falhas evitáveis.
  • Vários workers / réplicas: cada processo mantém os seus próprios contadores; em produção com várias instâncias, o limite efetivo por IP pode ser por processo, não um único teto global — o limite global na tabela aplica-se por instância da API.

Gerar e sua chave API

Sua chave api deverá ser requisitada através da plataforma do Mantis 3.0.

Sua chave api poderá ser visualizada uma única vez ao gerar. Posteriormente não será possível recuperar chave api.