Como Criar uma Nova Verificacao de API

Criar uma Nova Verificacao de API com o LoadFocus

E bastante facil criar uma nova verificacao de API para um endpoint usando a interface a partir da pagina de Nova Verificacao de API.

Configuracao da Verificacao de API

Configuracao da Verificacao de API

Passos para configurar uma nova verificacao de API

1. Nome Amigavel da Verificacao de API

Geramos automaticamente um nome amigavel para a sua verificacao de API usando a data e hora atuais. Pode edita-lo manualmente para definir um novo nome. Usaremos este nome nos alertas.

Nome da Verificacao de API

Veja mais detalhes sobre o Nome Amigavel da Verificacao.

2. Configuracao do Pedido da Verificacao de API

Defina o endpoint URL da sua API em teste e escolha entre os metodos HTTP permitidos: GET, POST, PUT, PATCH, DELETE. Tambem pode configurar parametros de consulta, cabecalhos, corpo POST, autenticacao basica, ignorar SSL e seguir redirecionamentos.

Configuracao do Pedido

Veja mais detalhes sobre a Configuracao do Pedido.

3. Pre-visualizacao do Pedido da Verificacao de API

Simule o pedido a partir de qualquer uma das 26 localizacoes na nuvem para pre-visualizar como a Verificacao de API se comportara. Verifique o tempo de resposta e metricas como Wait, DNS, TCP, TLS, Request, First Byte e Download. Veja o corpo completo da resposta da API, bem como os Cabecalhos do Pedido e da Resposta.

Pre-visualizacao do Pedido

Veja mais detalhes sobre a Pre-visualizacao do Pedido.

4. Frequencia da Verificacao de API

Selecione a frequencia com que deseja que a verificacao de API seja executada, com opcoes que variam de cada 10 segundos a cada 48 horas. Esta flexibilidade ajuda na monitorizacao continua da saude e desempenho da sua API.

Frequencia da Verificacao

Veja mais detalhes sobre a Frequencia.

5. Limites da Verificacao de API - Definir Limites de Tempo de Resposta

Marque a verificacao como degradada ou falhada com base nos limites de tempo de resposta. Configure os limiares de degradacao e falha em milissegundos para identificar problemas de desempenho antecipadamente.

Limites de Tempo de Resposta

Veja mais detalhes sobre os Limites de Tempo de Resposta.

6. Assercoes da Verificacao de API

Valide o codigo de estado, corpo, cabecalhos e tempo de resposta do seu pedido de API. Quando uma ou mais assercoes falham, um alerta e acionado.

Assercoes da Verificacao

Veja mais detalhes sobre as Assercoes.

7. Localizacoes da Verificacao de API

Execute a Verificacao de API a partir de uma ou varias localizacoes. Se a verificacao falhar numa localizacao, toda a verificacao e marcada como falhada. Escolha duas ou mais localizacoes para melhores informacoes de latencia da sua aplicacao.

Localizacoes da Verificacao de API

Veja mais detalhes sobre as Localizacoes.

8. Canais de Alerta da Verificacao de API

Selecione os canais de alerta nos quais deseja ser notificado quando esta verificacao falhar e recuperar. Pode definir alertas para multiplos enderecos de email, canais Slack e/ou canais Microsoft Teams.

Canais de Alerta

Veja mais detalhes sobre os Canais de Alerta.

9. Ativar/Desativar Verificacao de API

Alterne a Verificacao de API para ser ATIVADA ou DESATIVADA. Quando desativada, a Verificacao de API nao sera executada com base no agendamento configurado e sera exibida a cinzento na lista de Verificacoes de API.

Ativar Verificacao de API

Veja mais detalhes sobre Ativar/Desativar.

10. Silenciar/Ativar Som da Verificacao de API

Alterne a Verificacao de API para ser SILENCIADA ou COM SOM. Quando silenciada, a Verificacao de API continuara a ser executada com base no agendamento ou a pedido, mas nenhum alerta sera enviado.

Silenciar Verificacao de API

Veja mais detalhes sobre Silenciar/Ativar Som.

11. Guardar e Executar Verificacao de API

Clique no botao "Run Now" para pre-visualizar o pedido e ver se a Verificacao de API atual esta a passar ou a falhar. A partir deste ecra de pre-visualizacao, tambem pode guardar a Verificacao de API para ser executada com base no agendamento configurado.

Guardar Verificacao de API

Veja mais detalhes sobre Guardar e Executar.

Seguindo estes passos, pode facilmente configurar e monitorizar os seus endpoints de API para garantir que estao a funcionar de forma otima e estao disponiveis para os seus utilizadores.

Pode encontrar todas as suas Verificacoes de API na pagina de Monitores de API.