post
https://plataforma.bigdatacorp.com.br/monitoramento/teste
DescriçãoEste endpoint permite simular e validar as configurações do serviço de monitoramento. Utilizando dados de um monitoramento ativo ou de uma consulta de enriquecimento recente, a ferramenta processa as regras definidas e simula o envio de um alerta através dos canais configurados (e-mail, webhook ou SFTP). O objetivo é garantir a eficiência e a segurança durante a integração com a plataforma de monitoramento.> ℹ️ Nota> Esta funcionalidade é oferecida sem custos, estando sujeita a um limite de utilização de 1000 requisições por mês.## Parâmetros de EntradaA tabela a seguir descreve os parâmetros de entrada deste método, indicando se são obrigatórios ou não.|Campo|Obrigatório?|Descrição|Valores Possíveis||:---:|:---:|:---:|:---:||AccessToken|Sim|Token de autenticação para as APIs da Plataforma de Dados. Também pode ser informado no cabeçalho da requisição.|Token JWT||SubscriptionId|Não|Identificador de monitoramento|GUID||QueryId|Não|Identificador de monitoramento|GUID||Datasets|Não|Lista dos datasets monitorados, com as informações de campos monitoratos para cada um.|basic_data.listen(TaxIdStatus), kyc.listen(IsCurrentlySanctioned), etc||SubscriptionHooks|Não|Mecanismo de envio das informações (email, webhook ou sftp)|email{john@doe}, webhook{https://your-domain:1234}, file{sftp://user:password@dns:port}, etc||FieldsToUpdate|Não|Dicionário onde as chaves representam o caminho para o campo a ser modificado no objeto de saída e os valores correspondem aos novos dados a serem inseridos.|{"BasicData.TaxIdStatus": "TITULAR FALECIDO"}|## RetornoA tabela a seguir descreve os campos do objeto de retorno desse método.|Campo|Descrição||:---:|:---:||Success|Indica se o teste foi bem sucedido ou não.||ErrorMessage|Mensagem detalhada de erro, caso o teste tenha falhado.||TargetHook|Configuração de envio definida no campo SubscriptionHooks.||HookType|Tipo de mecanismo de envio (EMAIL, WEB ou FILE).||DeliveryDate|Data de envio dos dados da requisição de teste.||WebDelivery|Informações acerca do envio do web hook, como código HTTP, conteúdo e tempo da resposta do servidor especificado.||EmailDelivery|Informações acerca do envio de email, como assunto do email, remetente, destinatário e link do arquivo final. Se o envio por web hook também for informado, esse campo não é retornado.||FileDelivery|Informações acerca do envio por arquivo (FTP, SFTP ou S3), como protocolo, endereço do servidor e caminho para o arquivo|## ExemplosA seguir estão alguns exemplos de uso deste endpoint.POST: https://plataforma.bigdatacorp.com.br/monitoramento/testarjson Exemplo com QueryIdRequest:{ "QueryId":"22df1b42-7ffd-4438-890b-8703169d9bca", "Datasets":"basic_data.listen(taxidstatus,name)", "SubscriptionHooks":"web{https://webhook.site/}", "FieldsToUpdate": { "BasicData.TaxIdStatus": "TITULAR FALECIDO" }}Response:{ "SubscriptionTest": { "Success": true, "ErrorMessage": "", "TargetHook": "web{htt***************************************************9ff}", "HookType": "WEB", "DeliveryDate": "2025-07-16T16:48:38.3987214Z", "WebDelivery": { "WebUrl": "https://webhook.site/27ad6378-21a2-48ac-9dc6-ebdf4addb9ff", "ResponseTime": 1149, "ResponseCode": 200, "ResponseContent": "OK" } }, "QueryId": "2c0713df-a175-435d-a204-78a8a0c8f6ce", "ElapsedMilliseconds": 82756, "QueryDate": "2025-07-16T13:47:33.5379078-03:00", "Status": { "test": [ { "Code": 0, "Message": "OK" } ] }}``````json Exemplo com SubscriptionIdRequest:{ "SubscriptionId": "66eb250c116bae298ca4daef", "FieldsToUpdate": { "BasicData.TaxIdStatus": "TITULAR FALECIDO" }}Response:{ "SubscriptionTest": { "Success": true, "ErrorMessage": "", "TargetHook": "email{joa************************.br}", "HookType": "EMAIL", "DeliveryDate": "2025-07-16T19:14:38.9581525Z", "EmailDelivery": { "EmailSubject": "[BigDataCorp] Atualizações de Monitoramento", "SenderEmailAddress": "[email protected]", "RecipientEmailAddress": "joa************************.br", "OuputFileUrl": "htt****************zip" } }, "QueryId": "35f2fa41-cbef-4e5a-9b97-9410y25f025f", "ElapsedMilliseconds": 17157, "QueryDate": "2025-07-16T16:14:24.9775639-03:00", "Status": { "test": [ { "Code": 0, "Message": "OK" } ] }}
POST: https://plataforma.bigdatacorp.com.br/monitoramento/testarjson Exemplo com QueryIdRequest:{ "QueryId":"22df1b42-7ffd-4438-890b-8703169d9bca", "Datasets":"basic_data.listen(taxidstatus,name)", "SubscriptionHooks":"web{https://webhook.site/}", "FieldsToUpdate": { "BasicData.TaxIdStatus": "TITULAR FALECIDO" }}Response:{ "SubscriptionTest": { "Success": true, "ErrorMessage": "", "TargetHook": "web{htt***************************************************9ff}", "HookType": "WEB", "DeliveryDate": "2025-07-16T16:48:38.3987214Z", "WebDelivery": { "WebUrl": "https://webhook.site/27ad6378-21a2-48ac-9dc6-ebdf4addb9ff", "ResponseTime": 1149, "ResponseCode": 200, "ResponseContent": "OK" } }, "QueryId": "2c0713df-a175-435d-a204-78a8a0c8f6ce", "ElapsedMilliseconds": 82756, "QueryDate": "2025-07-16T13:47:33.5379078-03:00", "Status": { "test": [ { "Code": 0, "Message": "OK" } ] }}``````json Exemplo com SubscriptionIdRequest:{ "SubscriptionId": "66eb250c116bae298ca4daef", "FieldsToUpdate": { "BasicData.TaxIdStatus": "TITULAR FALECIDO" }}Response:{ "SubscriptionTest": { "Success": true, "ErrorMessage": "", "TargetHook": "email{joa************************.br}", "HookType": "EMAIL", "DeliveryDate": "2025-07-16T19:14:38.9581525Z", "EmailDelivery": { "EmailSubject": "[BigDataCorp] Atualizações de Monitoramento", "SenderEmailAddress": "[email protected]", "RecipientEmailAddress": "joa************************.br", "OuputFileUrl": "htt****************zip" } }, "QueryId": "35f2fa41-cbef-4e5a-9b97-9410y25f025f", "ElapsedMilliseconds": 17157, "QueryDate": "2025-07-16T16:14:24.9775639-03:00", "Status": { "test": [ { "Code": 0, "Message": "OK" } ] }}