Essa é a chamada básica da API de Preços, que retorna a tabela de preços completa associada com o cliente, ou os preços estimados das consultas com base nos datasets, na API, e no país informados. Assim, essa chamada suporta duas modalidades de consulta, descritas abaixo. Cada modalidade de consulta possui parâmetros de entrada e valores de retorno distindos. Nenhuma consulta realizada na API de Preços tem custo para o cliente.
Funcionalidade de Tabela de Preços Completa
Essa funcionalidade retorna a tabela completa de valores cadastrada para o cliente que está realizando a consulta.
O exemplo abaixo mostra como realizar uma chamada da Tabela de Preços Completa na API de Preços via POST:
Body:
{
}
O retorno contémpla a lista completa de datasets habilitados para o cliente, e as tabelas de preço, com as faixas de desconto, para cada um deles.
Funcionalidade de Preço Estimado de Consulta
Para requisitar o preço estimado de uma consulta, é necessário informar alguns parâmetros de entrada, descritos abaixo:
| Nome do Parâmetro | Descrição | Valores Possíveis |
|---|---|---|
| API | API que se deseja consultar | People, Companies, Validations, ... |
| Datasets | Datasets seriam consultados na API informada | Qualquer um dos datasets descritos na seção Datasets |
| Locale | (Opcional) Indicativo de localidade consultada | PT-BR, ES-MX, ... |
O exemplo abaixo mostra como realizar uma chamada de Preço Estimado de Consulta na API de Preços via POST:
Body:
{
"API": "People",
"Datasets" : "basic_data, phones, ondemand_rf_status, ondemand_coaf, ondemand_restiuicao, addresses, emails"
}
O retorno contém os datasets da lista enviada na entrada que foram localizados (que estão habilitados para o usuário e disponíveis nessa API), e o preço total da consulta. Caso algum dos datasets informados na entrada não tenha sido encontrado na API informada, mas exista em alguma outra, um indicador da API correta aonde o dataset se encontra é retornado.