Passar para o conteúdo principal

API de desenvolvedor e webhooks

Crie chaves de API, registre endpoints de webhook e revise os logs de requisições no Centro do Desenvolvedor.

Escrito por Sarah Chen

A Central do Desenvolvedor é onde você conecta o Exayard ao seu próprio código e às suas ferramentas. Abra-a em Configurações e depois Desenvolvedor. A partir daqui, você cria chaves de API, registra endpoints de webhook e revisa um log ao vivo de cada requisição de API. Apenas administradores da organização podem acessar esta página.

Chaves de API

Uma chave de API autentica requisições à API do Exayard. As chaves pertencem à sua organização, então a conta certa é selecionada automaticamente e não há ID de organização para passar.

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

O Exayard mostra a chave completa uma vez, logo após você criá-la. Copie-a então, porque ela nunca é mostrada novamente. Depois disso, cada chave aparece com seu nome, uma prévia 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 seus escopos. Use o ícone de lixeira para Revogar uma chave. A revogação é permanente e qualquer integração que use aquela chave para de funcionar imediatamente.

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

Webhooks

Um webhook diz ao Exayard para notificar seu servidor quando algo acontece. Abra a aba Webhooks e clique em + para adicionar um endpoint. Insira a URL que deve receber as entregas e uma Descrição opcional.

Escolha em quais Eventos se inscrever. Selecione Todos para receber cada evento, ou Específicos para escolher da lista:

Evento

Dispara quando

project.created

Um projeto é criado

project.updated

Um projeto é alterado

project.archived

Um projeto é arquivado

assessment.started

Uma avaliação de levantamento começa

assessment.completed

Uma avaliação é concluída

assessment.approved

Uma avaliação é aprovada

assessment.cancelled

Uma avaliação é cancelada

estimate.generated

Um orçamento é gerado

bid.generated

Uma proposta é gerada

file.processed

Um arquivo enviado termina de ser processado

Quando você cria um endpoint, o Exayard mostra um segredo de assinatura uma vez. Copie-o então, porque ele não é mostrado novamente.

Como proteger as entregas de webhook

Cada entrega carrega um cabeçalho Exayard-Signature no formato t=<unix>,v1=<digest>. O Exayard constrói a assinatura unindo o timestamp e o corpo da requisição e então assinando-os com HMAC-SHA256 usando o segredo do seu endpoint.

Para verificar uma entrega, recalcule a assinatura com seu segredo, confirme que o timestamp está dentro de cinco minutos do momento atual e compare os digests. Entregas com falha são repetidas com backoff exponencial ao longo de cerca de três dias.

Para editar um endpoint, clique no ícone de lápis. Você pode alterar a URL, a descrição e os eventos, e definir seu Status como Ativo ou Pausado. Endpoints pausados param de receber entregas. O mesmo diálogo tem um botão Rotacionar segredo. A rotação emite um novo segredo e o antigo para de funcionar imediatamente, então atualize seu servidor antes de rotacionar. O ícone de lixeira exclui um endpoint e encerra todas as entregas para ele.

Início rápido

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

Documentação

O cartão Documentação dá acesso à documentação completa do desenvolvedor e à especificação OpenAPI, que descreve cada rota e schema. Conectar MCP abre a configuração para conectar agentes de IA diretamente ao Exayard.

Logs

A seção Logs registra suas requisições de API mais recentes, tanto da API REST quanto do MCP. Cada linha mostra o método, o caminho, o status da resposta e a latência. Selecione uma linha para ver todos os seus detalhes, incluindo o ID da requisição e os corpos da requisição e da resposta. Use os logs para confirmar que uma chamada funcionou ou para depurar uma integração com falha.

Respondeu à sua pergunta?