DOCUMENTAÇÃO

Documentação do Espobase

O Espobase está em acesso antecipado. Estas páginas descrevem como a plataforma funciona; guias detalhados e referências de API estão sendo escritos à medida que cada recurso é lançado.

← InícioIr para o painel →

Primeiros passos

  1. Crie uma conta e uma organização.
  2. Crie um projeto. Ele recebe seu próprio banco de dados dedicado.
  3. Crie tabelas no Editor de tabelas ou descreva seu app para o construtor com IA.
  4. Chame sua API REST com a chave publicável do projeto.
curl "<project URL>/rest/v1/todos?select=*" \
  -H "apikey: <publishable key>"

Projetos

Um projeto é o backend de um app: seu próprio banco de dados PostgreSQL, API REST, chaves de API e usuários do app (App Authentication). Os projetos pertencem a uma organização.

Banco de dados

Cada projeto recebe um banco de dados PostgreSQL 18 dedicado. As tabelas do schema public são expostas pela API REST; as políticas de segurança em nível de linha decidem quem pode ler ou alterar cada linha.

API REST

Cada tabela recebe endpoints sob a URL REST do seu projeto (…/project/<project-ref>/rest/v1, exibida na página API do projeto). Envie uma chave publicável (eb_pk_…) a partir de navegadores e apps; as requisições dela são anônimas e a segurança em nível de linha decide o que elas podem ver. Adicione o token de acesso de um usuário conectado como Authorization: Bearer para executar requisições como esse usuário. As chaves secretas (eb_sk_…) ignoram os controles de acesso por usuário e só devem ser usadas em servidores confiáveis.

Autenticação

O Espobase App Authentication oferece aos usuários do seu app cadastro e login com e-mail e senha, separados da sua conta do Espobase. Os usuários ficam no banco de dados do seu projeto. O login retorna um token de acesso de curta duração (assinado com a chave própria do seu projeto) e um token de atualização rotativo; o SDK @espobase/client os mantém atualizados e envia o token em cada requisição, para que a segurança em nível de linha veja o usuário como autenticado. Sem um token de usuário, as requisições com a chave publicável são anônimas. As chaves secretas atuam como uma função de serviço no servidor e só devem ser usadas em servidores confiáveis.

Segurança em nível de linha

A segurança em nível de linha está ativada em toda tabela nova, seja criada no Editor de tabelas, no Editor SQL, em uma migração ou com o construtor com IA. Até você adicionar políticas em Banco de dados → Políticas, as chaves publicáveis não veem nenhuma linha; as chaves secretas (somente no servidor) veem tudo. Você sempre revisa o SQL gerado antes que ele seja executado. Leitura pública funciona para todos. Somente usuários conectados, Usuário é dono da linha, Associação à organização e Somente administradores se aplicam a usuários conectados com App Authentication: espobase.user_id() é o id do usuário conectado e espobase.app_role() a função dele no app, ambos tirados do token verificado. Associação à organização também precisa da sua própria tabela de associações (com uma política que permita aos usuários ler as próprias associações), e Somente administradores precisa de funções de app que você atribui no servidor.

Armazenamento

Os buckets guardam arquivos. O acesso segue o mesmo modelo de segurança em nível de linha das suas tabelas.

Tempo real

Atualizações ao vivo para o seu app com espobase.realtime: envie mensagens para todos em um canal, veja quem está online com a presença e receba as alterações das linhas das tabelas que você ativar em Tempo real, no painel. Cada inscrito recebe apenas as linhas que o usuário dele pode ler pelas regras de segurança da tabela; exclusões enviam apenas a chave primária da linha. Veja o guia completo em espobase.com/docs/realtime.

Edge Functions

Seu próprio código de servidor com espobase.functions: funções TypeScript que você publica pelo painel ou pela CLI, para webhooks, pagamentos, e-mails e outras tarefas de servidor. As funções de cada projeto rodam no próprio ambiente isolado; os segredos ficam guardados criptografados, os usuários conectados são verificados para você e a saída de cada chamada aparece em Logs. Veja o guia completo em espobase.com/docs/functions.

Hospedagem

Publique o front end do seu app ao lado do backend: gere o build do site, publique a pasta pelo painel ou com `espobase deploy` e ele fica no ar em `https://<nome>.espohost.com` com HTTPS. Cada deploy é guardado, então você pode voltar atrás com um clique. Disponível nos planos Pro e Group. Guia completo em espobase.com/docs/hosting.

Construtor de backend com IA

Descreva seu app e o Espobase propõe tabelas, relacionamentos e políticas. Você revisa cada instrução; nada é executado sem a sua aprovação.

Busca vetorial

Todo projeto inclui pgvector: guarde embeddings em colunas vector, indexe-os com HNSW e busque por similaridade com uma função do banco de dados chamada pela API REST ou por espobase.rpc(). A segurança em nível de linha se aplica. Veja o guia completo em espobase.com/docs/vector.

CLI

npx espobase login e depois npx espobase init: vincule uma pasta a um projeto, gere tipos TypeScript, execute consultas somente leitura e confira logs e uso pelo terminal. Veja o guia completo em espobase.com/docs/cli.

Conectar ferramentas de IA (MCP)

Use o Espobase no Claude, ChatGPT, Cursor ou VS Code: eles leem seu esquema, a referência de API, os logs e o uso, executam consultas somente leitura e propõem mudanças que você aprova. Veja o guia completo em espobase.com/docs/ai-tools.