Skip to content
ObraXRAY Business

Embed - documentação técnica

Há duas formas de mostrar o ObraXRAY no seu site. O selo afiliado é grátis, neutro e dá-lhe partilha de receita. O widget com chave, pago, mostra o risco completo dentro do seu produto. Ambos são um bloco de HTML e um script, sem tocar no resto da página.

Embed afiliado (grátis)#

O selo afiliado é grátis de integrar. Mostra aos seus utilizadores que existe uma pré-análise de risco da construtora e leva-os ao relatório no ObraXRAY. Quando alguém compra, partilhamos a receita consigo. Nunca mostra pontuação, cor de risco nem veredicto: é um convite a verificar, não um selo de aprovação.

Dois formatos

Escolha o formato conforme o espaço que tem no site.

Cartão

Um bloco compacto para uma ficha de empresa, com o botão de pré-análise.

Pré-visualização
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="card"></div>

Selo em linha

Para listas e tabelas, ao lado do nome de uma empresa. Ocupa pouco espaço.

Pré-visualização
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="seal"></div>

Instalar

Peça-nos a sua chave de afiliado (obx_pk_...), associada ao seu domínio. Depois cole o bloco onde quiser, com o NIF da empresa, e carregue o script uma vez por página. Funciona em qualquer site ou CMS.

<div data-obx-nif="514566680" data-obx-key="obx_pk_..." data-obx-variant="card"></div>
<script src="https://obraxray.com/embed/v1/obx-embed.js" async></script>

Atribuição e partilha de receita

Cada clique no selo leva ao relatório com um ?ref com o seu identificador de parceiro. Fica um cookie de 60 dias no ObraXRAY; se o utilizador comprar nesse período, a comissão é sua. Nós tratamos do cálculo e do pagamento, não tem de gerir nada.

Neutro por definição

No seu site, o selo mostra apenas isto, e nunca pontuação, semáforo de risco, veredicto ou sinais detalhados:

  • O logótipo ObraXRAY, com um escudo de verificação
  • «Verifique esta construtora»
  • «Pré-análise baseada em fontes públicas oficiais»
  • Um botão para abrir a pré-análise completa no ObraXRAY

Embed com chave (pago)#

Para empresas que querem mostrar o risco completo, pontuação e sinais, dentro do próprio produto (due diligence de construtoras no seu fluxo). Faz parte da ObraXRAY Business e usa uma chave de embed do seu plano. Na maioria dos casos faz mais sentido via API, com o seu próprio interface.

Três variantes, da mais compacta à mais detalhada. A chave está associada ao seu domínio e ao seu plano.

summaryrecomendada · linha única

Uma barra com o veredicto e a cor de risco. Encaixa em quase todo o lado.

Pré-visualização
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="summary"></div>

compactselo pequeno

Um selo mínimo com o veredicto, para tabelas e listas densas.

Pré-visualização
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="compact"></div>

detailedcartão

Um cartão com pontuação, sinais principais e a data da última análise.

Pré-visualização
<div data-obx-nif="514566680"
     data-obx-key="obx_pk_..."
     data-obx-variant="detailed"></div>

Configuração#

Atributos no <div> do selo:

  • data-obx-nifO NIF da construtora a analisar. Obrigatório.
  • data-obx-keyA sua chave de embed (obx_pk_...), que emitimos e limitamos ao seu domínio. Obrigatório.
  • data-obx-variantseal ou card no afiliado; summary, compact ou detailed no pago. As chaves de afiliado são sempre forçadas às variantes neutras.
  • data-obx-langIdioma das etiquetas: "pt" (predefinido) ou "en". Cai para o <html lang> mais próximo.

Allowlist de domínios#

Cada chave está limitada aos domínios que autorizar connosco. Um pedido de outro domínio é recusado, por isso a chave não serve a mais ninguém mesmo que fique visível no HTML.

Limites#

Cada chave tem limites de utilização por defeito, folgados para uso normal num site. Se precisar de mais volume, fale connosco e ajustamos.

Privacidade#

O selo não põe cookies no seu site nem segue os seus utilizadores. O cookie de atribuição é do ObraXRAY (primeira parte lá), e só é escrito quando o utilizador clica e chega ao relatório.

Contacto#

Para pedir a sua chave de afiliado ou o embed com chave, escreva para [email protected] ou fale connosco.