⌨️ Fazendo a Primeira Consulta

As APIs da Plataforma de Dados suportam o método POST com protocolo HTTPS. Para fazer uma consulta, basta enviar uma requisição para a URL da API que você deseja consultar, passando como parâmetro um número de documento, os nomes dos datasets que você quer receber no retorno, e o seu token de acesso.

Formalmente, a requisição de consulta suporta quatro parâmetros, conforme a tabela abaixo:

O exemplo abaixo mostra como executar uma consulta a API de pessoas para recuperar os dados básicos associados a um CPF.

Body:
{
    "Datasets": "basic_data",
    "q": "doc{xxxxxxxxxxx}"
}

Limite de consultas

Por uma questão de segurança, tanto do cliente como nossa, colocamos um limite de 5000 consultas por mês para toda nova conta. Esse limite visa minimizar problemas causados por integrações feitas de maneira errada que levem a consultas além do desejado ou outras situações similares.

• Uma vez que você alcance o limite de consultas definido para o seu usuário, você vai receber uma mensagem de retono na API, "YOU HAVE REACHED THE QUERY LIMIT FOR THIS DATASET". Para aumentar o limite de consultas, basta você mandar um e-mail para o seu representante de Customer Success com o título "Aumento do Limite - [Nome da Sua Empresa]", dando detalhes de qual aumento você precisa e em quais datasets.

Datasets Restritos

Caso você esteja tentando fazer uma consulta e esteja recebendo no retorno a mensagem "DATASET UNAVAILABLE", isso significa que o dataset que você está tentando acessar não está liberado para o seu usuário. Para pedir a liberação, envie um e-mail para o seu representante de Customer Success com o título "Liberação de Dataset - [Nome do Dataset]", que será feita a liberação do dataset para o seu usuário.

Lembre-se de confirmar a tabela de preço de cada dataset que você deseja consumir, pois eles serão contabilizados em sua conta ao fim de cada mês.