Acompanhar a API e as integrações
Veja todas as integrações que as prefeituras criaram, quantas chamadas cada uma fez nas últimas 24 horas e quantas foram bloqueadas por limite.
Para: Usuário da empresa
As prefeituras podem ligar outros sistemas ao GedFlow pela API: o sistema de protocolo que consulta processos, o portal da transparência que busca documentos autenticados, o sistema tributário que anexa a planta do imóvel. Cada ligação dessas é uma integração.
Quem cria, configura e revoga as integrações é o administrador da prefeitura, no painel dela (veja Integrações). A empresa não cria nem edita integração de ninguém: o seu papel é acompanhar, para perceber cedo quando algo está fora do normal.
A tabela de integrações#
No menu Configurações, abra API e integrações. A tabela mostra todas as integrações de todas as prefeituras, as usadas mais recentemente primeiro:
| Coluna | O que é |
|---|---|
| Prefeitura | De quem é a integração. |
| Integração | O nome que a prefeitura deu (ex.: "Sistema de protocolo"). |
| Ativa | Se está ligada. |
| Chamadas (24 h) | Quantas requisições ela fez nas últimas 24 horas. |
| Bloqueadas por limite | Quantas dessas foram recusadas por passar do limite por minuto. Fica destacada quando é maior que zero. |
| Limite/min | O limite de requisições por minuto da integração. Quando a prefeitura não definiu um próprio, aparece o padrão da plataforma. |
| Último uso | Há quanto tempo foi a última chamada, ou Nunca. |
Use a busca para achar uma prefeitura ou uma integração pelo nome.
Como ler os sinais#
- Bloqueadas por limite acima de zero. O sistema da prefeitura está chamando mais rápido do que o permitido. Na maioria das vezes é um programa mal ajustado, repetindo a mesma consulta em laço. Avise a prefeitura: quem programou a integração deve espaçar as chamadas ou respeitar o tempo de espera que a API informa (veja Limites).
- Muitas chamadas de repente. Um salto grande de um dia para o outro pode ser uma carga inicial legítima (um sistema novo sincronizando o acervo todo) ou um problema. Na dúvida, pergunte.
- Ativa e "Nunca" usada. Integração criada e esquecida. Uma integração parada é uma porta aberta sem necessidade: sugira à prefeitura revogá-la.
Os limites em camadas#
Para que um sistema mal comportado não deixe a plataforma lenta para todo mundo, a API tem limites por minuto em várias camadas: por integração, pela soma de cada prefeitura, por usuário dos aplicativos, para operações pesadas (busca, download e envio) e para os avisos enviados (webhooks). Passou do limite, a API recusa a chamada e diz quanto tempo esperar.
Os valores são editados em Configurações > Plataforma, no card Limites da API (requisições por minuto) (veja Plataforma e integrações). Ali também fica o Teto por integração: a prefeitura pode ajustar o limite de cada integração dela, mas nunca acima desse teto.
O que a empresa não vê aqui#
A página não mostra tokens de acesso nem segredos de webhook: eles aparecem uma única vez para a prefeitura, na criação, e nunca mais. Também não mostra o conteúdo das respostas. A empresa acompanha volume e saúde, não o que cada sistema consultou.
Para quem vai programar uma integração, a documentação técnica começa em Início rápido.