Introdução à API pública

Mostre os imóveis da imobiliária no seu site e receba os contatos direto no funil de vendas da Zariv.

A API pública da Zariv foi feita para sites de imobiliárias. Com ela, o site consulta os imóveis cadastrados no sistema (com fotos, valores e características), mostra os dados da imobiliária e envia para a Zariv os contatos dos visitantes: pedidos de visita, interesse em um imóvel ou vontade de anunciar.

Tudo que o corretor atualiza no sistema aparece no site sem trabalho extra, e todo contato recebido cai no funil de vendas e é distribuído para um corretor.

#Endereço base

https://web.zariv.com.br/api/public/v1

Todas as rotas começam por este endereço. Só existe a versão v1; mudanças que quebrem compatibilidade serão publicadas em uma nova versão, e a v1 continuará funcionando.

#O que você pode fazer

#Primeira chamada em 2 minutos

Com a sua chave em mãos (veja Autenticação), peça os 3 imóveis mais recentes:

curl "https://web.zariv.com.br/api/public/v1/imoveis?ordenar=recentes&por_pagina=3" \
  -H "Authorization: Bearer $ZARIV_API_KEY"

const resposta = await fetch("https://web.zariv.com.br/api/public/v1/imoveis?ordenar=recentes&por_pagina=3", {
  headers: { Authorization: `Bearer ${process.env.ZARIV_API_KEY}` },
});
const dados = await resposta.json();
console.log(dados);

import os, requests

resposta = requests.get(
    "https://web.zariv.com.br/api/public/v1/imoveis?ordenar=recentes&por_pagina=3",
    headers={"Authorization": f"Bearer {os.environ['ZARIV_API_KEY']}"},
    timeout=15,
)
print(resposta.json())

<?php
$ch = curl_init("https://web.zariv.com.br/api/public/v1/imoveis?ordenar=recentes&por_pagina=3");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("ZARIV_API_KEY")],
]);
$dados = json_decode(curl_exec($ch), true);
curl_close($ch);

A resposta traz a lista em imoveis e o total de resultados em total:

{
  "imoveis": [ { "id": "…", "codigo": "AP-102", "titulo": "Apartamento de 3 quartos no Centro", "valor_venda": 420000 } ],
  "total": 134,
  "pagina": 1,
  "por_pagina": 3
}

#Regras que valem para toda a API

• Formato: JSON em UTF-8. Nas requisições com corpo, envie Content-Type: application/json.
• Dados da sua imobiliária: a chave identifica a imobiliária. Você nunca vê dados de outra, e nunca informa o identificador dela.
• Só o que é público: proprietário, comissão, matrícula, observações internas e chaves do imóvel nunca saem pela API.
• Valores em reais como números (420000, não "R$ 420.000"). Áreas em metros quadrados.
• Campos opcionais simplesmente não aparecem quando não estão preenchidos. Trate a ausência como “não informado”.
• CORS liberado: a API aceita chamadas de qualquer origem, mas isso não torna seguro expor a chave no navegador (veja o aviso abaixo).

#Próximos passos