Estas boas práticas ajudam a usar a API de forma correta, evitar bloqueios, reduzir custos e manter o bom funcionamento das integrações.
Para detalhes técnicos, consulte a documentação oficial da API EVO, disponível ao final desta página.
1. Use a API apenas no backend
A API EVO deve ser usada apenas em sistemas de backend.
Não use a API diretamente no site ou aplicativo
Não exponha tokens ou credenciais
Proteja os dados da unidade e das pessoas clientes
A API foi criada para ser usada no backend, já que a autenticação básica exige o uso de chaves de API. Usar no frontend pode expor métodos e dados sensíveis do(s) seu(s) centro(s).
Isso evita falhas de segurança e uso indevido da API.
2. Use webhooks sempre que possível
Sempre que houver a opção, prefira webhooks em vez de fazer várias consultas à API.
Reduz a quantidade de chamadas
Evita consumo desnecessário
Diminui o risco de bloqueios
Recebe as informações automaticamente
Webhooks são a forma mais eficiente de acompanhar eventos e atualizações.
3. Evite chamadas repetidas ou desnecessárias
Antes de fazer uma chamada:
Verifique se a informação já está disponível
Evite buscar o mesmo dado várias vezes
Use filtros para trazer apenas o que precisa
Armazene dados usados com frequência em um banco de dados próprio, evitando consultar a API repetidamente
Menos chamadas ajudam a manter a API estável e reduzem custos.
4. Faça chamadas em grande volume durante a madrugada
Se a integração precisar fazer muitas chamadas de uma vez, programe esse uso para a madrugada.
Recomendação:
Entre 00h e 05h, sempre que possível
Esse período tem menos impacto no sistema e permite execuções mais eficientes.
Evite horários de pico: A API utiliza dados de produção e compartilha recursos com os processos do EVO.
5. Respeite os limites da API
Se a API bloquear uma chamada:
Aguarde antes de tentar novamente
Não insista em várias tentativas seguidas
Ajuste o volume de chamadas da integração
Ignorar os limites pode causar bloqueios temporários.
6. Acompanhe o consumo da API
Verifique com frequência:
Quantas chamadas estão sendo feitas
Quais tokens mais consomem
Em quais horários o uso é maior
Esse acompanhamento ajuda a identificar problemas e otimizar o uso da API.
7. Cuide bem dos tokens
Crie tokens apenas quando necessário
Use o token certo para cada integração
Inative ou exclua tokens que não estão mais em uso
Não compartilhe tokens por canais não seguros ou em locais com acesso de muitas pessoas
Tokens sem controle podem gerar consumo indevido e riscos de segurança.
Documentação técnica
Para informações técnicas completas, exemplos de uso e detalhes sobre limites e webhooks, consulte a documentação oficial da API EVO: