Enviar consulta
Veja os detalhes de como realizar o envio de uma ou mais consultas.
A partir deste serviço você poderá criar QUERIES de pesquisas de forma individual ou em massa tanto para documentos de pessoa física (CPF) quanto jurídica (CNPJ).
Fique atento quanto ao rate-limit de requisições para o correto funcionamento da API.
HTTP Simplificado
GET
https://api-v2.smsfire.com.br/bigdata/query/individual
Consumo simplificado via query strings para realizar consultas individuais tanto para documentos de pessoas física quanto jurídica.
Atenção: Campos com * (asterisco) são obrigatórios
Query Parameters
Name | Type | Description |
---|---|---|
document* | number | CPF ou CNPJ a ser consultado (Máx. 15 caracteres) |
customId | string | Id único personalizado da mensagem (Max. 40 caracteres) |
campaignId | integer | Id da campanha que deseja vincular a query |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Basic <Token> |
pageAutenticaçãoO parâmetro
customId
aceita caracteres alfanuméricos, hífen, underline/underscore e ponto sem espaços ou quebra de linha.
Exemplo de requisição
Query com parâmetros mínimos
GET https://api-v2.smsfire.com.br/bigdata/query/individual?document=11122233344
Query com todos os parâmetros
GET https://api-v2.smsfire.com.br/bigdata/query/individual?document=11122233344&customId=fire00001&campaignId=201
Para o correto funcionamento é imprescindível realizar o encoding da URL para que não haja erros na leitura dos dados pela API.
REST (JSON)
POST
https://api-v2.smsfire.com.br/bigdata/query/bulk
A partir deste método você poderá realizar queries de múltiplos documentos, seja pessoa física e/ou jurídica. Passe os parâmetros necessários por um objeto JSON no corpo da requisição.
Atenção: Campos com * (asterisco) são obrigatórios
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Basic <Token> |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
queries* | array | Matriz com a relação dos documentos. |
document* | number | CPF ou CNPJ a ser pesquisado.
Faz parte do objeto inserido em |
customId | string | Id único personalizado. (Máx. 40 caracteres).
Faz parte do objeto inserido em |
campaignId | integer | Id da campanha para vincular a consulta. |
O parâmetro
customId
aceita caracteres alfanuméricos, hífen, underline/underscore e ponto sem espaços ou quebra de linha.
É possível enviar no máximo 250 documentos por requisição
Exemplos de requisição
Envio simplificado de requisição com parâmetros mínimos obrigatórios:
Exemplo de JSON com reutilização de campanha e id personalizado definido pelo cliente
Last updated