Limitações do embed

Tipo

Referência

Para

Parceiro whitelabel, Desenvolvedor

O que a API do embed não faz hoje, e o que fazer no lugar. A lista acompanha a API e muda quando ela muda.

Login e sessão

Limitação	O que fazer
A sessão dura 1 hora a partir de quando o token foi gerado, sem renovação. Navegar pelo DataViz não estica o prazo	Recarregue o iframe com uma URL nova antes de completar 1 hora
A URL pode ser usada mais de uma vez enquanto vale. Quem a tiver entra como aquele usuário até ela vencer	Não registre a URL em log, não mande por e-mail nem para o navegador de outra pessoa
Domínio com mais de um endereço faz a url sair com a lista inteira no lugar do host, e ela não abre	Monte a URL a partir do token, como em Gerar a URL
E-mail de alguém da equipe HorusBI responde 403 com USER_LOGIN_NOT_ALLOWED	Use um usuário do tenant

Usuários

Limitação	O que fazer
POST /v1/tenant/login não cria usuário	Confira o e-mail e crie o usuário antes de gerar a URL, como no caminho completo
Senha e nome valem na plataforma: quem já existe em outro tenant mantém a senha, e nome muda o nome em todos os tenants	Veja Criar o usuário
A API não dá o grupo de administrador, não põe ninguém num grupo padrão do Cliente invisível para o tenant e não edita nem exclui grupo gerenciado pelo Cliente	Faça essas alterações no HEC

Tenant e template

Limitação	O que fazer
O nome do tenant é único na plataforma: a API recusa o nome de outro tenant não excluído, mesmo de outro Cliente	Inclua no nome o ID do cliente no seu sistema
POST /v1/tenants é síncrono e só responde depois de aplicar o template inteiro, o que leva dezenas de segundos	Use timeout de pelo menos 2 minutos e external_id para repetir com segurança
Só template do seu Cliente: o de outro Cliente responde TEMPLATE_NOT_FOUND, igual a um que não existe	Liste os seus em GET /v1/tenants/templates
Versão nova não chega sozinha. A API não informa qual versão cada tenant tem, e o apply aceita só o id da versão	Para ver quem está desatualizado e instalar em lote, use a Linha de Produto no HEC. Veja Versão nova do template
POST /v1/tenant/templates/apply aceita credentialMap para apontar cada conexão do template para uma do tenant, mas a API não lista as chaves das conexões do template	Pela API, vale a escolha automática descrita em Conexões na versão nova
DELETE /v1/tenants não tem volta pela API	Para tirar o acesso e poder voltar atrás, desative com "ativo": false. Desativar também suspende a cobrança a partir do mês seguinte, e os dados das tabelas são apagados na limpeza diária. Veja Desativar e excluir
Os nomes dos campos de conexão só estão documentados para o PostgreSQL	Salve uma conexão de teste do mesmo tipo pelo HorusETL e veja os nomes em GET /v1/tenant/credentials

Carga e estado

Limitação	O que fazer
A API não avisa quando a carga termina ou quando o tenant fica pronto	Consulte GET /v1/tenant/executions/{id} ou o status do tenant de tempos em tempos. Veja Saber se a carga terminou
A criação não carrega dados: as tabelas ficam vazias até alguém disparar os agendamentos ou chegar o primeiro horário deles	Dispare a carga depois de criar

Contrato da API

Limitação	O que fazer
Parte das rotas responde { "status", "data" } e parte responde { "success", "message" }. O login responde sem envelope	Decida pelo status HTTP e pelo code do erro
Em /v1/tenant (Tenant Token), o status de erro segue a causa: 400, 403, 404, 409 ou 413. Em /v1/tenants (Client Token), criar, alterar e excluir recusam com 400 qualquer que seja a causa	Leia o code, que diz qual foi o erro
POST /v1/tenant/groups/functions e POST /v1/tenant/groups/functions/list respondem HTTP 200 mesmo quando o grupo não existe, com "success": false dentro de data	Confira data.success
Até 100 pedidos por segundo por IP, contados em cada servidor da API. Acima disso, HTTP 429 com Too Many Requests e o header Retry-After	Espere o Retry-After. Veja Limite de pedidos