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>

200 Objeto JSON

{
  "campaignId": 201,
  "queries": [
    {
      "id": 123,
      "customId": "fire0001",
      "statusCode": 0,
      "statusName": "PENDING"
    }
  ]
}

400 Objeto JSON quando a requisição possuir algum dado inválido

{
  "error": {
    "message": "Invalid duplicated customId request"
  }
}

O parâmetro customId aceita caracteres alfanuméricos, hífen, underline/underscore e ponto sem espaços ou quebra de linha.

Autenticação

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 queries
customId	string	Id único personalizado. (Máx. 40 caracteres). Faz parte do objeto inserido em queries
campaignId	integer	Id da campanha para vincular a consulta.

200 Array do objeto JSON

{
  "campaignId": 201,
  "queries": [
    {
      "id": 123,
      "customId": "fire00001",
      "statusCode": 0,
      "statusName": "PENDING"
    },
    {
      "id": 124,
      "customId": "fire00002",
      "statusCode": 0,
      "statusName": "PENDING"
    }
  ]
}

400 Objeto JSON quando a requisição possuir algum dado inválido

{
  "error": {
    "message": "Invalid duplicated customId request"
  }
}

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

Autenticação

Exemplos de requisição

• Envio simplificado de requisição com parâmetros mínimos obrigatórios:

curl

curl --request POST \
  --url https://api-v2.smsfire.com.br/bigdata/query/bulk \
  --header 'Authorization: Basic <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"queries":[{"document":"11122233344"},{"document":"44455566677"}]}'

nodeJs

var axios = require("axios").default;

var options = {
  method: 'POST',
  url: 'https://api-v2.smsfire.com.br/bigdata/query/bulk',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Basic <TOKEN>'
  },
  data: {queries: [{document: '11122233344'}, {document: '55566677788'}]}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

python

import requests

url = "https://api-v2.smsfire.com.br/bigdata/query/bulk"

payload = {"queries": [{"document": "11122233344"}, {"document": "55566677788"}]}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <TOKEN>"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

php

<?php

$curl = curl_init();
$payload = [
  "queries" => [
    [
      "document" => "11122233344"
    ],
    [
      "document" => "55566677788"
    ]
  ]
];
    
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.smsfire.com.br/bigdata/query/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <TOKEN>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

• Exemplo de JSON com reutilização de campanha e id personalizado definido pelo cliente

{
	"campaignId":201,
	"queries":[
		{
			"document":"11122233344",
			"customId":"fire-cpf-0001"
		},
		{
			"document":"334445550000199",
			"customId":"fire-cnpj-0002"
		}
	]
}