API de Integração
Automatize a recepção de mídias profissionais e conecte a esteira de captura de imagens da Piperz diretamente com a sua imobiliária, CRM ou sistema interno.
Como funciona a Integração?
A Piperz fornece um sistema de webhooks robusto. Sempre que uma sessão fotográfica (fotos, vídeos, drone, tour 360°, plantas) é finalizada por nossos editores, a nossa plataforma envia automaticamente uma notificação HTTP POST para o endpoint configurado por você, contendo as informações e os links para download dos arquivos.
Configure o Endpoint
No painel da Piperz, acesse a tela de Integração e informe a URL de recebimento (HTTP/HTTPS) do seu servidor.
Produção Automatizada
Nossos fotógrafos realizam o ensaio e nossa equipe faz o upload dos materiais editados na plataforma.
Recebimento Instantâneo
Seu sistema recebe os dados brutos e os links das mídias prontas em tempo real para publicar no anúncio.
Payload do Webhook
O corpo da requisição HTTP POST segue o formato JSON detalhado abaixo. O envio é estruturado para facilitar a identificação do imóvel e seus respectivos materiais.
| Campo | Tipo | Descrição |
|---|---|---|
| session_id | integer | Identificador exclusivo do agendamento / sessão na plataforma Piperz. |
| referencia | string | O identificador de referência fornecido por você (ex: código do imóvel no seu CRM). |
| endereco | string | O endereço físico do imóvel onde o ensaio foi realizado. |
| material | array (objects) | Lista contendo as mídias profissionais organizadas por serviço. |
| material[].servico | string | Nome do serviço (ex: “fotos”, “videos”, “tour”). |
| material[].items | array (strings) | URLs diretas seguras para acesso ou download dos arquivos digitais. |
| material[].empreendimento | boolean | Indica se a mídia refere-se ao condomínio / áreas de lazer gerais (true) ou à unidade privativa (false/omitido). |
{
"session_id": 1,
"referencia": "IMOV-98745",
"endereco": "Avenida Paulista, 1106 - Bela Vista, São Paulo/SP",
"material": [
{
"servico": "fotos",
"items": [
"https://saas.piperz.io/session-photo/exemplo/f1.jpg",
"https://saas.piperz.io/session-photo/exemplo/f2.jpg"
]
},
{
"servico": "fotos empreendimento",
"empreendimento": true,
"items": [
"https://saas.piperz.io/session-photo/exemplo/area-lazer.jpg"
]
},
{
"servico": "tour",
"items": [
"https://tour.birdie.com.br/EnfKBJiq6oq"
]
}
]
}Monitoramento e Logs de Envio
A Piperz valoriza a transparência e confiabilidade da operação. No menu de integração do seu painel corporativo, você tem acesso ao Log de Envios em tempo real, que permite:
- Verificar códigos de status HTTP: Veja a resposta exata devolvida pelo seu servidor (ex:
200 OKpara recebimento com sucesso, ou códigos500/404em caso de falhas). - Visualizar histórico de payload: Inspecione os dados enviados a cada tentativa.
- Reenvio Manual (Resend): Em caso de instabilidade na sua API, clique no botão para disparar novamente o webhook para qualquer ensaio finalizado.
Precisa de ajuda com a integração?
Nosso time de desenvolvedores e engenheiros de suporte está à disposição para auxiliar você no mapeamento do JSON e na configuração do webhook para a sua plataforma.