Esta página apresenta recursos avançados que complementam o uso das consultas na Plataforma de Dados da BigDataCorp.

Aqui você aprenderá como:

Utilizar hashes como alternativa ao envio direto de documentos
Adicionar tags às chamadas para rastreamento e organização de fluxos
Explorar metadados para análise posterior de eventos e integrações

Esses recursos ajudam a adaptar as consultas a diferentes requisitos de segurança, privacidade e governança.

1️⃣ Hashes como chave de consulta

Em alguns cenários, o cliente pode não se sentir confortável em enviar diretamente o CPF ou CNPJ em uma requisição, seja por questões de privacidade, regras internas ou simplicidade operacional.

Para atender a esses casos, a Plataforma de Dados permite o envio do documento hasheado como chave de consulta, utilizando o parâmetro dochash. O hash deve ser gerado no padrão SHA-256, amplamente adotado no mercado.

Exemplo:

{
    "Datasets": "addresses",
    "q": "dochash{A457CEBA5B8481AFF573336A02A1BB022BD43056F48B022AD0C6320E87EF9EF9}"
}

Esse recurso permite realizar consultas mantendo a compatibilidade com as APIs, sem expor diretamente o documento original.

2️⃣ Tags de chamada

As tags são identificadores customizados utilizados para categorizar, organizar e adicionar contexto às chamadas realizadas na Plataforma de Dados.

Elas funcionam como metadados no formato chave: valor, sendo registradas junto às informações da requisição.

Todas as APIs da Plataforma permitem o envio de tags.

Entre os principais usos das tags estão:

Identificação de fluxos (ex.: onboarding, análise de crédito)
Diferenciação de ambientes (ex.: homologação, produção)
Rastreabilidade de integrações e processos internos
Análise posterior por meio da API de eventos

Exemplos:

Uso simples de tags

{
  "Datasets": "basic_data",
  "q": "doc{xxxxxxxxxxx}",
  "Tags": {
    "my_key": "my_value",
    "environment": "production"
  }
}

Tags aplicadas a um fluxo específico

{
  "Datasets": "registration_data,kyc,occupation_data",
  "q": "doc{xxxxxxxxxxx}",
  "Tags": {
    "host": "HOST_ID",
    "process": "ONBOARDING"
  }
}

📘
Essas tags podem ser utilizadas como filtros na API de eventos, permitindo recuperar chamadas relacionadas a um determinado processo ou fluxo de negócio.

Regras de uso das tags

Para que a requisição seja processada corretamente, as tags devem seguir as regras abaixo:

É permitido enviar no máximo 10 tags por requisição.
As chaves e valores devem ter entre 1 e 255 caracteres.
As chaves podem conter apenas letras de A a Z (sem acentuação) ou o caractere _ (underline).
Os valores podem conter letras, números, espaços e os seguintes caracteres especiais: _ * - + , . : ! @ # & /

✨ A partir daqui, você já domina os recursos essenciais e está pronto para avançar no uso das APIs e datasets específicos da Plataforma de Dados.