Documentação para
Integração de Leilões

leilao extrajudicial

Visão Geral

Somos uma plataforma especializada na divulgação de leilões de imóveis. Para garantir uma integração eficaz, solicitamos que os programadores dos leiloeiros criem um endpoint que possamos acessar diariamente via requisição HTTP para obter todos os leilões de imóveis no formato JSON.

Requisição

  • Método: GET
  • URL: Endpoint fornecido pelo leiloeiro.
  • Autenticação: Caso o leiloeiro deseje maior segurança, pode implementar um token de autenticação e nos fornecer.
  • Formato de Resposta: A resposta deve ser fornecida em JSON, com a estrutura descrita abaixo.
  • Frequência de Requisição: Nós realizamos 1 requisição por dia, em horário de menor acesso, de noite ou de madrugada.
  • Status HTTP Esperado: A resposta bem-sucedida deve retornar o status HTTP 200 OK. Em caso de erro, retorne códigos de status apropriados (400 Bad Request, 401 Unauthorized, 500 Internal Server Error, etc.).
  • Sem Restrições: O endpoint não deve utilizar proxies, bloqueios de IP ou serviços que possam limitar ou interromper as solicitações automáticas. Caso seja necessário, configure regras específicas para liberar o acesso à nossa requisição.

Atenção caso possuir um Endpoint/API aberta já pronta

Por favor consultar nossa equipe

Estrutura Esperada do JSON

Cada objeto de leilão deve conter as seguintes propriedades:

Campos Obrigatórios:

  • titulo (string): Título do leilão.
  • data_primeira_praca (string, formato Tipo Date): Data da primeira praça.
  • lance_minimo_primeira_praca (number): Valor mínimo do lance na primeira praça.
  • data_segunda_praca (string, formato Tipo Date): Data da segunda praça.
  • lance_minimo_segunda_praca (number): Valor mínimo do lance na segunda praça.
  • estado (string): Estado onde o imóvel está localizado.
  • cidade (string): Cidade onde o imóvel está localizado.
  • link_leilao (string): URL do leilão.
  • descricao (string): Descrição do leilão.
  • fotos (array de strings): URLs das fotos do imóvel.
  • endereco (string): Endereço completo do imóvel.
  • numero_processo (string): Número do processo relacionado ao leilão.
  • edital (string): Link para o edital do leilão.

Campos Necessários não obrigatórios:

  • metragem_m2 (number): Área total em metros quadrados.
  • tipo (string): Tipo de leilão (Extrajudicial, Judicial, etc.).
  • latitude (number): Latitude do imóvel.
  • longitude (number): Longitude do imóvel.
  • tipo_bem (string): Tipo de bem (Apartamento, Casa, Rural, etc.).
  • avaliacao (number): Valor de avaliação do imóvel.

Importante

Caso algum dos campos opcionais não esteja disponível, não há problema. Contudo, quanto mais dados forem fornecidos, melhor será o desempenho do leilão na nossa plataforma, devido aos nossos algoritmos de ranqueamento.

Suporte

Para quaisquer dúvidas, marcar reuniões ou obter suporte mais rápido, entre em contato pelo WhatsApp: (16) 99741-6325, identificando-se como representante do leiloeiro.



Agradecemos pela colaboração!



spy leilões logo