Ir para conteúdo principal

API e webhooks para programadores

Crie chaves de API, registe pontos de extremidade de webhook e consulte os registos de pedidos no Centro de Programadores.

Escrito por Sarah Chen

O Centro de Programadores é onde liga o Exayard ao seu próprio código e às suas ferramentas. Abra-o em Definições e, depois, Programador. A partir daqui, cria chaves de API, regista pontos de extremidade de webhook e revê um registo em direto de cada pedido à API. Apenas os administradores da organização podem aceder a esta página.

Chaves de API

Uma chave de API autentica os pedidos à API do Exayard. As chaves pertencem à sua organização, por isso a conta certa é selecionada automaticamente e não há nenhum ID de organização para passar.

Abra o separador Chaves de API no cartão Credenciais e clique no botão +. Dê um Nome à chave e, depois, escolha os seus Âmbitos. Selecione Todos para conceder todos os âmbitos, ou Específicos para escolher permissões individuais. Os âmbitos seguem uma divisão de leitura e escrita por recurso, como read:projects e write:estimates. O âmbito admin:org é uma concessão de acesso total. Escolha os âmbitos mínimos de que a sua integração precisa.

O Exayard mostra a chave completa uma vez, logo após a criar. Copie-a nessa altura, porque nunca mais é mostrada. Depois disso, cada chave aparece com o seu nome, uma pré-visualização mascarada como ak_••••1234 e a data em que foi usada pela última vez.

Use o ícone de lápis para renomear uma chave ou alterar os seus âmbitos. Use o ícone do caixote do lixo para a Revogar. A revogação é permanente e qualquer integração que use essa chave deixa de funcionar de imediato.

A mesma chave autentica as integrações sem código. Consulte Ligar o Exayard ao Zapier, Ligar o Exayard ao Make e Ligar o Exayard ao n8n. Para acesso de agentes e editores de IA, consulte Ligar ao Claude e a outras ferramentas de IA.

Webhooks

Um webhook diz ao Exayard para notificar o seu servidor quando algo acontece. Abra o separador Webhooks e clique em + para adicionar um ponto de extremidade. Introduza o URL que deve receber as entregas e uma Descrição opcional.

Escolha quais os Eventos que pretende subscrever. Selecione Todos para receber todos os eventos, ou Específicos para escolher da lista:

Evento

Disparado quando

project.created

É criado um projeto

project.updated

Um projeto é alterado

project.archived

Um projeto é arquivado

assessment.started

Começa uma avaliação de medição

assessment.completed

Uma avaliação termina

assessment.approved

Uma avaliação é aprovada

assessment.cancelled

Uma avaliação é cancelada

estimate.generated

É gerado um orçamento

bid.generated

É gerada uma proposta

file.processed

Um ficheiro carregado termina o processamento

Quando cria um ponto de extremidade, o Exayard mostra um segredo de assinatura uma vez. Copie-o nessa altura, porque não é mostrado novamente.

Proteger as entregas de webhook

Cada entrega inclui um cabeçalho Exayard-Signature na forma t=<unix>,v1=<digest>. O Exayard constrói a assinatura juntando o carimbo temporal e o corpo do pedido e, depois, assinando-os com HMAC-SHA256 usando o segredo do seu ponto de extremidade.

Para verificar uma entrega, volte a calcular a assinatura com o seu segredo, confirme que o carimbo temporal está dentro de cinco minutos do momento atual e compare os resumos. As entregas falhadas voltam a ser tentadas com recuo exponencial ao longo de cerca de três dias.

Para editar um ponto de extremidade, clique no ícone de lápis. Pode alterar o URL, a descrição e os eventos, e definir o seu Estado como Ativo ou Em pausa. Os pontos de extremidade em pausa deixam de receber entregas. A mesma caixa de diálogo tem um botão Rodar segredo. A rotação emite um novo segredo e o antigo deixa de funcionar de imediato, por isso atualize o seu servidor antes de rodar. O ícone do caixote do lixo elimina um ponto de extremidade e termina todas as entregas para ele.

Início rápido

O cartão Início rápido contém um prompt pronto a usar para um editor de IA como o Claude ou o Cursor. Clique em Copiar prompt e cole-o no seu editor. O prompt inclui o URL base da API, o formato de autenticação, o vocabulário de âmbitos e o esquema de assinatura de webhooks, para que a IA possa criar a estrutura de uma integração funcional e lhe peça os detalhes de que precisa.

Documentação

O cartão Documentação liga à documentação completa para programadores e à especificação OpenAPI, que descreve cada rota e esquema. Ligar MCP abre a configuração para ligar agentes de IA diretamente ao Exayard.

Registos

A secção Registos regista os seus pedidos de API mais recentes, tanto na API REST como no MCP. Cada linha mostra o método, o caminho, o estado da resposta e a latência. Selecione uma linha para ver o seu detalhe completo, incluindo o ID do pedido e os corpos do pedido e da resposta. Use os registos para confirmar que uma chamada funcionou ou para depurar uma integração com falhas.

Isto respondeu à sua pergunta?