Embed no seu sistema

O embed mostra o DataViz dentro do seu sistema, num iframe, com login sem senha. O seu backend pede à API uma URL de login para o e-mail do usuário e entrega essa URL ao navegador.

O login é a única parte que exige a API. Tenants, usuários e permissões podem ser cadastrados no HEC ou pela API.

Os dois tokens

A API usa dois tokens Bearer.

O Client Token é do Cliente, a organização que licenciou a plataforma (você, parceiro). Com ele você lista, cria, altera e exclui tenants, e lista os templates. Ele serve para os endpoints /v1/tenants e fica no HEC, no cadastro do Cliente, aba Desenvolvedor.

O Tenant Token é de um tenant só. Com ele você cadastra usuários, define permissões, gera o login transparente, aplica template e dispara cargas. Ele serve para os endpoints /v1/tenant e fica no HEC, no cadastro do tenant, aba Desenvolvedor. Também vem no campo token de cada tenant em GET /v1/tenants, então quem tem o Client Token chega a todos os Tenant Tokens sem abrir o HEC.

Guarde os dois no seu backend e nunca mande para o navegador. Os dois dão acesso de administrador: quem tem o Tenant Token gera login como qualquer usuário daquele tenant.

O que você automatiza

Tarefa	No HEC	Pela API	Página
Abrir o BI sem senha no seu sistema	Não	Sim, com o Tenant Token	Login transparente
Cadastrar usuários e permissões	Sim	Sim, com o Tenant Token	Usuário automático
Criar o tenant e aplicar o template	Sim	Sim, com o Client Token	Tenant automático

Comece pelo login. Automatize o cadastro de usuários e a criação de tenants quando o volume de clientes pedir.

O caminho completo

Sequência de chamadas com tudo pela API. A etapa que você fizer no HEC sai do fluxo.

Antes de começar

Vale para qualquer integração:

• Domínio próprio para o DataViz. Ponha o DataViz num subdomínio do seu sistema. A sessão do iframe fica num cookie do domínio do DataViz. Com o DataViz em bi.suaempresa.com.br e o seu sistema em app.suaempresa.com.br, o navegador vê os dois como o mesmo site e mantém a sessão. Com o DataViz em dataviz.horusbi.com.br dentro de um sistema em outro domínio, navegadores que bloqueiam cookie de terceiros derrubam a sessão. Veja Domínio próprio.
• Chamadas sempre do servidor. Os dois tokens ficam no seu backend. O navegador só recebe a URL de login, que vale por 1 hora e só para aquele usuário.
• Endereço da API. Todos os endpoints ficam sob https://api.horusbi.com.br/v1. A referência da API traz cada operação com os campos completos.