Em Definições › Acesso à API, pode criar tokens de acesso pessoal para que um script ou um cliente MCP possa usar Dvina em seu nome. Os administradores também podem adicionar webhooks nesta secção para enviar os eventos do Livespace para os seus próprios sistemas.
O acesso à API está incluído no plano Enterprise. Todos os membros podem criar os seus próprios tokens; apenas os proprietários e administradores veem Webhooks.
Criar um token
- Abra Definições e escolha Acesso à API.
- Em Tokens de acesso pessoal, escolha Criar token.
- Introduza um Nome para saber mais tarde onde é utilizado.
- Escolha o Acesso: Só de leitura ou Leitura e escrita.
- Escolha quando Expira: Dentro de 30 dias, Dentro de 90 dias, Dentro de 365 dias ou Nunca expira.
- Escolha Criar token.
- Em Copiar o seu token, copie o token e guarde-o num local seguro. Esta é a única vez que é apresentado.
Um token atua em seu nome, no Livespace onde o criou, com a função que tem atualmente nesse Livespace. Um token Só de leitura permite ler, mas não permite adicionar nem alterar nada.
Para usar um token com um cliente MCP, consulte Ligar com uma chave de API em vez de OAuth.
Verificar, renovar ou revogar um token
Os seus tokens são apresentados em Tokens de acesso pessoal, juntamente com o respetivo acesso. Escolha um para ver o seu início em Começa por, o respetivo Acesso, quando foi Utilizado pela última vez e quando Expira.
- Para substituir um token, escolha Renovar… e, em seguida, Renovar para confirmar. Um novo token substitui o anterior, que deixa de funcionar de imediato. Copie o novo token em Copiar o seu token.
- Para desativar um token, escolha Revogar… e, em seguida, Revogar para confirmar. Tudo o que o utiliza deixa de funcionar de imediato.
A criação, renovação e revogação de um token ficam registadas no registo de auditoria.
Adicionar um webhook
Um webhook envia os eventos do Livespace, os mesmos registos que constam do registo de auditoria, para um endereço à sua escolha.
- Em Definições › Acesso à API, na secção Webhooks, escolha Adicionar webhook.
- Introduza um Nome e o URL. Use um URL HTTPS público.
- Em Eventos, deixe o campo vazio para receber todos os eventos ou indique ações e áreas, como
member.addedousharing.*. - Escolha Adicionar.
- Em Copiar o segredo de assinatura, copie o segredo. Esta é a única vez que é apresentado.
Se Dvina apresentar Não é possível aceder a este endereço a partir de Dvina, use um URL HTTPS público.
Verificar a assinatura de cada pedido
Dvina envia eventos em lotes, em formato JSON, e assina todos os pedidos. Use o segredo de assinatura para verificar se um pedido veio de Dvina:
- Cada pedido tem um cabeçalho
X-Dvina-Signaturecomot=<timestamp>,v1=<signature>. - A assinatura é um HMAC-SHA256, em hexadecimal, calculado a partir da marca temporal, de um ponto e do corpo do pedido, usando o seu segredo de assinatura.
- Calcule a assinatura e compare-a com a recebida. Rejeite qualquer pedido cuja assinatura não corresponda ou cuja marca temporal seja demasiado antiga.
Consultar ou alterar um webhook
Os seus webhooks aparecem em Webhooks com o respetivo estado: Ativo, Em pausa ou Com falhas. Selecione um para ver os detalhes.
- Para o alterar, edite o Nome, o URL ou os Eventos e selecione Guardar.
- Para o colocar em pausa, desative Enviar eventos. Volte a ativar esta opção para retomar o envio.
- Para verificar o seu funcionamento, consulte o Estado e o número de eventos Enviados. Um webhook com falhas apresenta o Último erro. O Dvina continua a tentar e regista a falha no registo de auditoria.
- Para alterar o segredo, selecione Novo segredo de assinatura… e confirme. Os pedidos passam imediatamente a ser assinados com o novo segredo, pelo que deve atualizar o recetor de imediato.
- Para o remover, selecione Eliminar… e, em seguida, Eliminar para confirmar. Não lhe serão enviados mais eventos.