Descrição
Este endpoint realiza a inscrição de monitoramento para um novo registro através do QueryId de uma chamada feita anteriormente.
Parâmetros de Entrada
A tabela a seguir descreve os parâmetros de entrada deste método, indicando se são obrigatórios ou não.
| Campo | Obrigatório? | Valores Possíveis | Descrição |
|---|---|---|---|
| AccessToken | Sim | Token de autenticação na API da Plataforma de Dados. Também pode ser passado no cabeçalho da requisição. | Token JWT |
| QueryId | Não | QueryId de uma chamada realizada anteriormente. Caso fornecido, os parâmetros seguintes não devem ser informados. | QueryId |
| SubscriptionHooks | Sim | Mecanismo de envio das informações (email, webhook ou sftp) | Mecanismo a ser utilizado para o envio das atualizações dos dados. Veja a descrição da API de Monitoramento para mais detalhes. |
| Datasets | Não | Datasets e configurações | Lista de datasets a serem monitorados e suas configurações, clique aqui para saber mais. |
Retorno
Este método retorna um SubscriptionId, que é uma identificação única da assinatura de monitoramento. Recomendamos armazenar esta informação para eventual uso posterior.
Exemplos
A seguir estão alguns exemplos de uso deste serviço:
POST: https://plataforma.bigdatacorp.com.br/monitoramento/monitorar
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"QueryId": "<QUERY_ID>",
"SubscriptionHooks": "email{[email protected]}"
}
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"QueryId": "<QUERY_ID>",
"Datasets": "basic_data.listen(TaxIdStatus)",
"SubscriptionHooks": "web{http://your-domain:1234}, authorizationtoken{YOUR_AUTH_TOKEN}"
}
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"QueryId": "<QUERY_ID>",
"Datasets": "kyc.listen(IsCurrentlyPEP, PEPHistory.JobTitle, IsCurrentlySanctioned)",
"SubscriptionHooks": "file{sftp://user:password@dns:port},sshkeyauth{true},remotefilepath{/path/to/folder}"
}
{
"QueryId": "b9886b7d-c796-43ac-b97d-c5006a33ecd5",
"ElapsedMilliseconds": 88,
"QueryDate": "2024-09-18T19:07:56.7202733Z",
"Status": {
"subscription": [
{
"Code": 0,
"Message": "OK"
}
]
},
"Evidences": {},
"SubscriptionId": "66eb250c116bae298ca4daee"
}
Atenção
Os QueryIds originados por requisições em lote não são aceitos para ativar o monitoramento.
Configurando os Datasets
O parâmetro Datasets pode ser enviado na requisição para possibilitar editar as configurações da chamada feita para o QueryId informado. A seguir estão dois exemplos relacionados ao que pode ser feito através deste parâmetro.
- Selecionar apenas datasets específicos para serem monitorados dentro de uma chamada.
{
"Datasets": "basic_data, kyc, profession_data",
"q": "doc{XXXXXXXXXXX}"
}
{
"QueryId": "<QUERY_ID>",
"Datasets": "basic_data",
"SubscriptionHooks": "<HOOKS>"
}
- Sobrescrever configurações de campos a serem monitorados.
{
"Datasets": "basic_data, kyc, profession_data",
"q": "doc{XXXXXXXXXXX}"
}
{
"QueryId": "<QUERY_ID>",
"Datasets": "basic_data.listen(TaxIdStatus), kyc.listen(IsCurrentlyPEP, IsCurrentlySanctioned), profession_data.listen(IsEmployed)",
"SubscriptionHooks": "<HOOKS>"
}
Atenção
Não é possível fazer alterar filtros, limites ou seleção de campos através desta funcionalidade.