Listar produtos
curl --request GET \
--url https://{instancia}/api/v1/produtos \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instancia}/api/v1/produtos"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instancia}/api/v1/produtos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instancia}/api/v1/produtos",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instancia}/api/v1/produtos"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instancia}/api/v1/produtos")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instancia}/api/v1/produtos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"escopos": [
"cpf",
"cnpj"
],
"produtos": [
{
"id": "search-pf",
"nome": "Ficha completa",
"descricao": "<string>",
"documento": "cpf",
"assunto": "pessoa",
"assuntoRotulo": "<string>",
"familia": "cadastral",
"familiaRotulo": "<string>",
"pesada": true
}
]
}{
"erro": {
"codigo": "nao_encontrado",
"mensagem": "Documento não localizado.",
"detalhe": {}
}
}Consultar documentos
Listar produtos
Devolve o catálogo que a sua chave pode consultar. Não toca no bureau e não custa nada, o que faz dela o jeito barato de descobrir o contrato em vez de chutar um id de produto e pagar para ver o erro.
Produto que a chave não pode pedir não aparece na lista.
GET
/
api
/
v1
/
produtos
Listar produtos
curl --request GET \
--url https://{instancia}/api/v1/produtos \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instancia}/api/v1/produtos"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instancia}/api/v1/produtos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instancia}/api/v1/produtos",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instancia}/api/v1/produtos"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instancia}/api/v1/produtos")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instancia}/api/v1/produtos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"escopos": [
"cpf",
"cnpj"
],
"produtos": [
{
"id": "search-pf",
"nome": "Ficha completa",
"descricao": "<string>",
"documento": "cpf",
"assunto": "pessoa",
"assuntoRotulo": "<string>",
"familia": "cadastral",
"familiaRotulo": "<string>",
"pesada": true
}
]
}{
"erro": {
"codigo": "nao_encontrado",
"mensagem": "Documento não localizado.",
"detalhe": {}
}
}Devolve o catálogo que a sua chave pode consultar, com id, descrição e tipo de documento
de cada produto.
Produto que a chave não pode pedir não aparece na lista, porque listar o que já se sabe
que vai voltar
Não gera cobrança
Não toca no bureau. É o jeito barato de descobrir o contrato em vez de chutar um id de
produto e pagar para ver o erro.
403 é convite a uma chamada perdida.
Resposta:
{
"escopos": ["cpf", "cnpj"],
"produtos": [
{
"id": "search-pf",
"nome": "Ficha completa",
"descricao": "Tudo o que se sabe da pessoa: nome, mãe, nascimento, telefones, e-mails, endereços, renda presumida e vínculos.",
"documento": "cpf",
"assunto": "pessoa",
"assuntoRotulo": "Pessoa",
"familia": "cadastral",
"familiaRotulo": "Quem é e como falar",
"pesada": false
}
]
}
Authorizations
Chave de API criada em Configurações, Integrações, Chaves de API. Começa com sk_live_ e aparece uma vez só. O cabeçalho X-API-Key também é aceito, com o mesmo valor.