Documentação do Archie Core

Documentação do Archie Core

Bem-vindo ao Console Backend. Esta plataforma atua como o centro de comando central para a lógica do lado do servidor, arquitetura de dados e infraestrutura da sua aplicação. Fornece uma interface unificada para gerir a sua base de dados, explorar a sua API GraphQL auto-gerada e configurar serviços essenciais da aplicação.

---

Visão Geral da Plataforma

Modelo de Dados

O Modelo de Dados é a fundação da sua aplicação. Aqui, define a estrutura da sua base de dados sem escrever scripts de migração complexos.

• Tabelas: Crie e gira tabelas de base de dados (ex: users, audit_events) para armazenar os registos da sua aplicação.
• Esquema e Campos: Defina tipos de dados específicos (Texto, Número, Data, UUID) e configure relacionamentos entre tabelas.
• Vistas e Tipos de Dados: Crie Vistas SQL para agregação de dados complexa e defina Tipos de Dados (Enums) reutilizáveis para padronizar valores no seu esquema.

Explorador de API

O Explorador de API é um ambiente GraphiQL integrado que permite interagir diretamente com a API da sua aplicação.

• API Auto-gerada: O sistema gera automaticamente Consultas (Queries), Mutações (Mutations) e Subscrições (Subscriptions) GraphQL baseadas no seu Modelo de Dados.
• Compositor: Uma ferramenta visual para construir consultas simplesmente clicando em campos, eliminando a necessidade de digitar sintaxe manualmente.
• Documentação: Aceda a documentação em linha e em tempo real para o seu esquema para entender os campos e argumentos disponíveis.

SQL Playground

Para operações de dados avançadas, o SQL Playground fornece um editor SQL bruto.

• Acesso Direto: Execute consultas SQL padrão (SELECT, JOIN, etc.) diretamente nas suas tabelas de base de dados.
• Depuração: Ideal para testar lógica complexa ou depurar problemas de dados que são difíceis de rastrear via API GraphQL.

Integrações

Estenda as capacidades da sua aplicação conectando serviços de terceiros através do módulo de Integrações.

• Comunicação: Conecte Slack ou Twilio para mensagens.
• Email: Configure SendGrid para emails transacionais.
• Pagamentos: Integre Stripe para processar pagamentos.
• IA: Conecte ChatGPT para funcionalidades inteligentes.

Serviços de Aplicação

Esta secção gere os componentes de infraestrutura principais necessários para uma aplicação moderna:

• Gestor de Ficheiros: Configure fornecedores de armazenamento como AWS S3, Google Cloud Storage, Filestack ou Azure Blob Storage para lidar com uploads de utilizadores e ficheiros.
• Fornecedores de Autenticação: Configure métodos de login seguros usando Auth0, Google, AWS Cognito ou Tokens de API padrão.
• Funções (Roles): Defina RBAC (Controlo de Acesso Baseado em Função) para gerir permissões e restringir o que diferentes utilizadores (ex: Admin, Cliente) podem ver ou fazer.

Definições

O menu Definições controla a configuração global e a segurança do seu projeto:

• Chaves de API: Gere e gira chaves de API para permitir que aplicações externas se liguem com segurança ao seu backend.
• Variáveis de Ambiente: Armazene valores de configuração sensíveis (como chaves secretas ou URLs externas) com segurança como pares chave-valor.
• Rede: Configure políticas CORS (Partilha de Recursos de Origem Cruzada) e defina Limites de Taxa para proteger a sua API contra abusos.