Descrição
Este endpoint permite personalizar as configurações da API de Monitoramento, possibilitando a definição de preferências como o formato dos arquivos de saída (CSV ou JSONL) e o cadastro de credenciais de autenticação para integrações via Webhook e SFTP. É importante destacar que não é necessário utilizar este método para iniciar o uso da API, uma vez que os usuários são criados automaticamente com configurações padrão ao realizarem a primeira requisição. Utilize este endpoint apenas quando precisar modificar comportamentos específicos ou atualizar chaves de segurança, sabendo que os campos omitidos na requisição manterão seus valores originais.
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 nas APIs da Plataforma de Dados. Também pode ser informado no cabeçalho da requisição. | Token JWT |
| SendSubscriptionChanges | Não | true ou false | Define se os detalhes sobre os valores alterados devem ser enviados com os dados atualizados (padrão: true). |
| OutputFileFormat | Não | CSV ou JSONL | Define o formato do arquivo de saída para os envios de monitoramento, tanto por e-mail quanto por SFTP (padrão: CSV). |
| SftpPrivateKey | Não | Chave SFTP | Chave de autenticação privada para servidores no formato OpenSSH |
| CustomHeaders | Não | Cabeçalhos Customizados | Pares de chave e valor customizados a serem preenchidos nos envios de web hook. |
| AuthorizationKey | Não | Chave de autorização | Chave de acesso |
| AuthorizationToken | Não | Token de autorização | Token |
| OAuthBasicToken | Não | Token básico de OAuth | Token OAuth |
| OAuthPublicKey | Não | Este campo deve ser usado junto ao OAuthPrivateKey, caso o OAuthBasicToken não seja informado | Chave de acesso |
| OAuthPrivateKey | Não | Chave privada de OAuth | Chave de acesso |
| OAuthURLTarget | Não | URL de acesso ao servidor de autenticação | URL |
| OAuthContentType | Não | Tipo de conteúdo que deve ser retornado | Tipo de conteúdo |
| OAuthGrantType | Não | Determina o tipo de autorização | Tipo de permissão |
| OAuthExpectedTokenFieldName | Não | Indica o nome do campo onde o access token será recuperado na resposta da autenticação OAuth (valor padrão: "access_token"). | Nome do campo |
Os campos AuthorizationToken e OAuthBasicToken não ficam armazenados em nossas bases de dados. Utilizamos o serviço de persistência de chaves da AWS, oferecendo mais segurança às credenciais do usuário.
Exemplos
A seguir estão alguns exemplos de uso deste endpoint.
POST: https://plataforma.bigdatacorp.com.br/monitoramento/definirUsuario
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"AuthorizationKey": "<YOUR_AUTH_KEY>",
"AuthorizationToken": "<YOUR_AUTH_TOKEN>"
}
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"CustomHeaders": {
"ApiKey": "<YOUR_SECRET>"
}
}
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"SftpPrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----
<HIDDEN>
-----END OPENSSH PRIVATE KEY-----
"
}