Skip to content

API REST para integração com a plataforma HorusBI.

Autenticação

A API usa dois níveis de tokens Bearer:

Token Header Uso
Client Token Authorization: Bearer <token> Gerenciar múltiplos tenants
Tenant Token Authorization: Bearer <token> Operar dentro de um tenant específico

Modelo de Permissões

O acesso a dados é controlado via Datamarts com permissões granulares:

  • Por Tabela: Acesso individual a cada tabela
  • Por Coluna: Colunas sensíveis podem ser ocultadas
  • Por Linha (RLS): Filtros restringem registros visíveis
  • Por Tempo: Acessos temporários com expiração automática

Servidores

https://api.horusbi.com.br/v1

Autenticação

A API utiliza autenticação via Bearer Token. Existem dois tipos de tokens:

Client Token

Para operações multi-tenant (gestão de tenants). Use este token quando precisar gerenciar múltiplos tenants.

Tenant Token

Para operações dentro de um tenant específico. Use este token para operações de usuários, grupos, flows, etc.

Exemplo de Uso

Inclua o token no header de cada requisição:

http
Authorization: Bearer SEU_TOKEN_AQUI

Recursos Disponíveis

A API possui endpoints para gerenciar:

RecursoDescrição
TenantsCriação e gerenciamento de tenants
UsuáriosCriação, edição e gerenciamento de usuários
GruposCriação e gerenciamento de grupos com permissões
Flows ETLListagem e execução de flows
AgendamentosGerenciamento de agendamentos ETL
DatamartsCriação e gerenciamento de datamarts
TemplatesAplicação de templates em tenants

Próximos Passos

  • Use a sidebar para navegar diretamente para uma operação específica