📃 API de Eventos

A Plataforma de Dados conta com um robusto sistema de log e auditoria de todas as requisições realizadas contra o mesmo, independente de sua origem, da API consultada, ou do mecanismo utilizado para consultar essa API (chamada assíncrona, lote de consultas, ou qualquer outro). O sistema atribuí um identificador único para cada requisição realizada, que é retornado para o cliente no momento da consulta. Esse identificador pode, posteriormente, ser utilizado para encontrar todo o detalhamento relacionado com a consulta: seus parâmetros de entrada, os resultados retornados, e qualquer erro de processamento que tenha ocorrido, bem como um detalhamento do tempo de execução da consulta. São armazenadas ainda informações de auditoria, como o usuário que fez a consulta, e o IP do qual a consulta se originou.

A API de Eventos é o mecanismo que disponibilizamos para desenvolvedores e clientes acessarem esse log detalhado para recuperar esses registros históricos de consulta e todas as suas informações. Além da pesquisa pelo identificador único da consulta, ela permite também a consulta por outros parâmetros, bem como o filtro por datas específicas. Desta forma, a API de Eventos pode tanto ser utilizada para fins de auditoria quanto como um mecanismo simplificado de cache das informações consultadas.

Para saber mais sobre as diferentes operações disponíveis na API de Eventos, acesse a documentação técnica.