Visão Geral das Notificações#
O Apidog permite-lhe integrar aplicações de terceiros para enviar notificações a destinatários designados quando determinados eventos ocorrem. Quando um evento específico é acionado, as notificações são enviadas em tempo real para plataformas como o Slack. Os canais de notificação atualmente suportados incluem:Apenas administradores do projeto podem configurar as definições de notificação. Atualmente, as notificações por email estão disponíveis apenas para os seguintes eventos:Teste automatizado concluído/falhado
Integração contínua concluída/falhada
Tarefas agendadas concluídas/falhadas
Destinos de Notificação#
Os destinos de notificação são destinatários que recebem mensagens através de um canal específico quando determinados eventos acontecem.Para configurar notificações, em primeiro lugar, tem de criar um destino de notificação especificando um nome, selecionando um canal e configurando as respetivas definições. Cada canal tem um processo de configuração único. As secções abaixo irão orientá-lo na configuração passo a passo.Slack#
O Apidog suporta o envio de eventos de notificação para um Canal específico no Slack através da integração de aplicações Slack — Incoming WebHooks — no Canal especificado e da configuração do URL do Webhook dos Incoming WebHooks, que pode enviar mensagens de eventos para o Canal do Slack.Descrição dos campos de configuração:| Campo de Configuração | Obrigatório | Descrição |
|---|
| Nome da Notificação | Não | Atribua um nome à notificação integrada de terceiros para registar a sua finalidade. |
| Eventos de Acionamento | Sim | Eventos suportados: alterações de API, alterações de schema, alterações de documento, importação de dados, testes de automatização |
| URL do Serviço | Sim | URL do Webhook em "Incoming WebHooks - Integration Settings" |
Os administradores do projeto podem utilizar funções de integração de terceiros para associar aplicações Slack — Incoming WebHooks adicionados no Slack — Canais com eventos de notificação do projeto no Apidog, para enviar alterações de API relacionadas, alterações de documentação, conclusões de testes, etc. para o Canal especificado no Slack.Passo 1: Abrir detalhes do canal
No canal do Slack, clique na opção "Abrir detalhes do canal" no canto superior direito.Passo 2: Instalar Incoming WebHook
Em Integrations - Apps do Canal específico, instale e adicione Incoming WebHook.Passo 3: Ver Incoming WebHooks
Depois de a instalação estar concluída, clique no botão à direita de Incoming WebHooks - View.Passo 4: Configurar Incoming WebHooks
Isto irá abrir a página de descrição de Incoming WebHooks; clique em Configuration para configurar.Passo 5: Adicionar ao Slack
Passo 6: Selecionar Canal e Adicionar Integração
Selecione o Canal para onde pretende enviar as mensagens de eventos de notificação do Apidog e clique em Add Incoming WebHooks integration.Passo 7: Obter URL do Webhook
Obtenha e copie o URL do Webhook.Passo 8: Criar destino de notificação no Apidog
Clique em "Definições" > "Notificações" > "Destinos de Notificação" > e crie um novo Destino de notificação.Preencha o nome do destino de notificação.
Escolha Slack como canal de notificação.
Cole o URL do Webhook obtido nas definições de Incoming WebHooks em Service URL.
Teams#
O suporte para o envio de notificações para o Microsoft Teams permite que os Workflows no Teams utilizem estas mensagens como acionadores para ações adicionais — como publicar automaticamente mensagens num grupo ou canal — ajudando as equipas a manterem-se informadas sobre eventos importantes do Apidog.Especificamente, pode configurar um Acionador de Webhook dentro de um Workflow. Quando determinados eventos de notificação no Apidog são acionados (por exemplo, alterações de API, atualizações de documentação ou conclusões de testes automatizados), o Apidog enviará um pedido POST para o URL HTTP POST especificado do acionador, transportando a carga útil do evento.| Campo | Obrigatório | Descrição |
|---|
| Nome | Sim | Um nome que descreve a finalidade deste destino de notificação |
| URL HTTP POST | Sim | O URL onde o Acionador de Webhook no Workflow recebe pedidos POST |
Passo 1: Criar um workflow no Teams
Em Microsoft Teams → Workflow, clique em Create, e pode começar rapidamente selecionando o modelo Post to a channel when a webhook request is received.Passo 2: Definir o nome do fluxo e a conta
Defina um nome para o fluxo, selecione a conta adequada e clique em Next.Passo 3: Escolher grupo e canal
Escolha o grupo e o canal onde pretende receber a notificação e, em seguida, clique em Create flow.Passo 4: Obter URL HTTP POST
Assim que o fluxo for criado, será apresentado o URL HTTP POST no passo do acionador. Pode copiá-lo diretamente ou encontrá-lo mais tarde no passo do acionador do fluxo.Passo 5: Configurar destino de notificação no Apidog
Cole este URL HTTP POST na configuração do destino de notificação no Apidog.Passo 6: Criar evento de notificação
Crie um evento de notificação no Apidog e associe-o ao destino de notificação do Teams configurado.Passo 7: Verificar notificação do Teams
Quando este evento de notificação for acionado, o workflow criado anteriormente publicará automaticamente uma mensagem no canal Teams selecionado.Webhook#
Suporta o envio de eventos de notificação para o Servidor HTTP. Pode enviar mensagens de eventos para o Servidor HTTP especificando um endereço URL para receber pedidos POST.Descrição dos campos de configuração:| Campo de Configuração | Obrigatório | Descrição |
|---|
| Nome da Notificação | Não | Atribua um nome à notificação integrada de terceiros para registar a finalidade da notificação. |
| Evento de Acionamento | Sim | Eventos suportados: alterações de API, alterações do modelo de dados, alterações de documento, importação de dados, testes de automatização |
| URL do Servidor | Sim | Endereço URL do Servidor HTTP para receber pedidos |
| Autenticação por Assinatura | Não | O conteúdo enviado é encriptado pelo algoritmo de encriptação HMAC SHA1, utilizando um token como KEY para apresentar o valor em hexadecimal (requer um token configurado), e contém o prefixo sha1= |
Os administradores do projeto podem utilizar a integração de terceiros para associar o seu Servidor HTTP autoalojado a eventos de notificação do projeto no Apidog, para receber notificações de alterações de API relevantes, alterações de documentos e conclusões de testes de automatização no seu Servidor HTTP.Para integrar a notificação do Apidog com um servidor HTTP autoalojado, clique em "Definições" > "Notificações" > "Destinos de Notificação" > e crie um novo Destino de notificação.1.
Preencha o nome do destino de notificação.
2.
Escolha Webhook como canal.
3.
Cole o URL do Servidor HTTP autoalojado no campo Service URL.
4.
Se a verificação de assinatura estiver ativada, copie e cole a chave no campo Signature Key.
Jenkins#
Suporta o envio de eventos de notificação para o serviço Jenkins. Ao configurar o URL do Webhook do Jenkins, as mensagens de eventos podem ser enviadas para o Jenkins.Descrições dos campos de configuração:| Campo de Configuração | Obrigatório | Descrição |
|---|
| Nome da Notificação | Não | Atribua um nome à notificação de integração de terceiros para registar a sua finalidade. |
| Eventos de Acionamento | Sim | Alterações de API, alterações do modelo de dados, importação de dados, testes de automatização. Serão acionadas notificações em tempo real quando qualquer um dos eventos acima ocorrer. |
| URL do Serviço | Sim | O URL é configurado no plugin Generic Webhook Trigger. |
| Autenticação por Assinatura | Não | Enviado para o plugin Generic Webhook Trigger através do cabeçalho Authorization Bearer. |
Os administradores do projeto podem utilizar a funcionalidade de integração de terceiros para associar o URL do Webhook configurado no plugin Jenkins Generic Webhook Trigger a eventos de notificação do projeto no Apidog, para acionar automaticamente uma ação de build no Jenkins quando eventos como alterações de API, alterações de documentos e conclusões de testes de automatização forem acionados, e visualizar mensagens no histórico de builds.Passo 1: URL do Webhook configurado no plugin Jenkins Generic Webhook Trigger
Crie uma nova vista no Painel do Jenkins:Clique na vista do passo anterior para entrar em Configure>Build Triggers e selecione Generic Webhook Trigger. O URL do Webhook é "http://"+"your service address"+"/generic-webhook-trigger/invoke"O token personalizado é suportado:Passo 2: Criar um novo destino de notificação
Clique em "Definições" > "Notificações" > "Destinos de Notificação" > e crie um novo Destino de notificação.Preencha o nome do destino de notificação.
Escolha Jenkins como canal
Se for utilizado um token personalizado, copie e cole o Token no campo Signature Token.
Email#
As notificações podem ser enviadas por email para endereços de email especificados. Atualmente, as notificações por email estão disponíveis apenas para os seguintes eventos:Teste automatizado concluído/falhado
Integração contínua concluída/falhada
Tarefas agendadas concluídas/falhadas
| Campo | Obrigatório | Detalhes |
|---|
| Nome | Sim | Um nome descritivo que realça a finalidade ou as características do destino de notificação. |
| Endereço de Email de Notificação | Sim | Introduza o(s) endereço(s) de email para receber notificações. Pode selecionar endereços de email de membros do projeto ou introduzir manualmente um endereço. São suportados vários endereços de email. |
1.
Preencha o nome do destino de notificação.
Eventos de Notificação#
Pode criar eventos de notificação para especificar que eventos irão acionar notificações para destinatários designados (destinos de notificação). Para configurar um evento de notificação, tem de configurar:Nome do Evento de Notificação
Evento de Acionamento#
Pode escolher entre os seguintes eventos de notificação para acionar a notificação:| Evento de Acionamento | Detalhes |
|---|
| Endpoint Alterado | Endpoint Criado
Endpoint Atualizado
Endpoint Eliminado |
| Schema Alterado | Schema Criado
Schema Atualizado
Schema Eliminado |
| Documento Alterado | Documento Criado
Documento Atualizado
Documento Eliminado |
| Importação de Dados | Importação (Importação Manual)
Importação (Sincronização Automática) |
| Componente de Resposta Alterado | Componente de Resposta Criado
Componente de Resposta Atualizado
Componente de Resposta Eliminado |
| Ramo de Sprint Alterado | Ramo de Sprint Intercalado
Ramo de Sprint Criado
Ramo de Sprint Arquivado
Ramo de Sprint Eliminado
Ramo de Sprint Recuperado |
| Versão da API Alterada | Versão da API Criada
Versão da API Eliminada |
| Esquema de Segurança Alterado | Esquema de Segurança Criado
Esquema de Segurança Atualizado
Esquema de Segurança Eliminado |
Para notificações relacionadas com testes automatizados (por exemplo, teste automatizado concluído, integração contínua concluída, tarefa agendada concluída), tem de configurar as definições individualmente para cada cenário de teste. Esta abordagem é mais flexível e adapta-se melhor a casos de utilização reais.
Destinos de Notificação#
Escolha que destinos de notificação receberão a notificação quando ocorrer um evento de acionamento. Pode escolher entre os destinos de notificação que já foram configurados no projeto e selecionar vários destinos, se necessário.No entanto, as notificações por email são suportadas apenas para três eventos específicos:Teste automatizado concluído/falhado
Integração contínua concluída/falhada
Tarefas agendadas concluídas/falhadas
