Referência
Eventos
Tudo o que acontece na empresa (um documento emitido, a validação da AGT, um pagamento) fica registado como um evento. Os webhooks enviam-nos na hora; aqui lêem-se, para recuperar avisos perdidos ou sincronizar sem webhooks.
Tudo o que acontece na empresa (um documento emitido, a validação da AGT, um pagamento) fica registado como um evento. Os webhooks enviam-nos na hora; aqui lêem-se, para recuperar avisos perdidos ou sincronizar sem webhooks.
| Operação | O que faz |
|---|---|
GET /api/eventos | Os eventos dos últimos 30 dias (documento emitido, validação ou recusa da AGT, anulação, pagamento, cliente criado), do mais recente para o mais antigo. |
/api/eventos#Os eventos dos últimos 30 dias (documento emitido, validação ou recusa da AGT, anulação, pagamento, cliente criado), do mais recente para o mais antigo.
Cada item traz o evento exactamente como o webhook o enviaria (evento), por isso o mesmo código trata os avisos e os eventos lidos. Ver Webhooks e assinaturas para o formato e a lista dos tipos.
tipo limita a um tipo de evento e desde (data e hora ISO 8601, em UTC) aos criados a partir desse instante. Os eventos de teste (webhook.test) não aparecem.
É a rede de segurança dos webhooks: se o seu servidor esteve em baixo mais do que os cerca de 3 dias em que o Mucanda insiste, ou criou o webhook depois, o que faltar lê-se aqui. Os eventos guardam-se 30 dias.
Precisa da permissão Webhooks.Ler (a mesma de uma pessoa). Gerir os webhooks é só de uma pessoa, no ecrã das Definições; uma chave de API só lê.
A resposta é uma página: itens e proximoCursor. Ver Paginação.
Parâmetros
| Nome | Onde | Tipo | Obrigatório |
|---|---|---|---|
tipo | na pesquisa | texto | |
desde | na pesquisa | data e hora (ISO 8601) | |
cursor | na pesquisa | texto | |
tamanho | na pesquisa | número inteiro |
Pedido
curl 'https://<endereço-da-API>/api/eventos' \
-H 'X-Api-Key: <a-sua-chave>'