Saltar para o conteúdo
BeryX
Voltar às respostas para RFP

Documentação do BeryX

Primeiros passos: Integrações

Este guia é para quem liga o BeryX a outros sistemas: pipelines, CI, agentes de código, BI e alertas. As integrações entram com um token de API, que só um administrador do workspace cria. Um token age como um membro sem equipa: só lê, salvo as operações que cada integração precisa.

Tokens de API

  • Criar: Administrar › Equipa › «Tokens de API». O scope de leitura serve quase tudo; o scope «Configuração como código» serve também para aplicar o datavault.yaml.
  • Validade: 90 dias por omissão, até 365. O valor só se vê uma vez: guarda-o num gestor de segredos.
  • Rodar sem partir nada: «Rodar» cria um token novo com o mesmo nome e scope, e o antigo continua válido durante o período de graça, 24 horas por omissão. «Revogar» corta-o logo.
  • Plano: os tokens de API pedem o plano Team ou superior.
  • Restrições da organização: se a organização limita as redes autorizadas, um token só entra de fora dessas redes quando está isento pelo nome.

O que podes ligar hoje

Para… Como Guia
Consultar a API REST https://api.praxis.lbostuff.tech/api/v1, com o token no cabeçalho Authorization: Bearer Portal de developers e Versionamento da API
Bloquear um deploy quando os dados falham O veredito de cada dataset, num passo do teu CI Quality gate no CI
Validar registos antes de os escrever A API de validação devolve o veredito de cada registo e não grava nada Validação de registos
Dar contexto de qualidade a um agente de código O servidor MCP remoto em https://mcp.praxis.lbostuff.tech/mcp; Compreender › Assistente › Ligar o teu agente dá a configuração pronta a colar Servidor MCP e Agentes de código
Fazer análises no Excel ou no Power BI Tabelas estáveis de scores, problemas, SLO, custos e atividade, pelo Power Query Ligar ao Excel / Power BI
Receber eventos noutro sistema Webhooks assinados com HMAC, configurados em Administrar › Notificações Webhooks
Linhagem entre ferramentas OpenLineage nos dois sentidos OpenLineage
Orquestradores Resultados do dbt e eventos do Airflow, do Fivetran e do Airbyte Orquestradores
Configuração como código datavault.yaml com plan e apply, com um token de scope «Configuração como código» Equipa

O SDK Python, o operador Airflow, o provider Terraform, a extensão do VS Code e o plugin para o Claude Code ainda não estão publicados nos registos públicos. Fala com a equipa da BeryxTech se precisares deles antes disso.

Boas práticas

  • Um token por integração, com o nome do sistema que o usa, para o poderes rodar ou revogar sem afetar as outras.
  • Usa o scope de leitura sempre que chega.
  • Roda os tokens antes de expirarem: a lista em Equipa diz quando expira cada um.

Ver também