v1.0
Acessar api.vupi.us

Conectar Aplicação Externa

Como conectar seu frontend ou aplicação externa às rotas do seu módulo.

Passo a passo

  1. Desenvolva e publique seu módulo na IDE
  2. Ative o módulo no painel lateral
  3. Envie um e-mail para [email protected] solicitando a inclusão da URL do seu frontend no CORS da plataforma
  4. Informe no e-mail: URL do frontend (ex: https://meuapp.com), nome do módulo e seu username na plataforma
  5. O admin_system adicionará a URL via Dashboard > Configurações > CORS
  6. Após aprovação, sua aplicação poderá fazer requisições à API
Tempo de aprovação

A liberação do CORS é feita manualmente pelo admin. O prazo pode variar. Após aprovação, a comunicação é imediata.

Exemplo de conexão (JavaScript)

Após a URL ser adicionada ao CORS, seu frontend pode fazer requisições normalmente:

// Login — obtém o token JWT
const loginRes = await fetch('https://api.vupi.us/api/login', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    credentials: 'include',
    body: JSON.stringify({
        login: 'meu_usuario',
        senha: 'minha_senha'
    })
});
const { access_token } = await loginRes.json();

// Usar as rotas do módulo com o token
const res = await fetch('https://api.vupi.us/api/task', {
    method: 'GET',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + access_token
    }
});
const data = await res.json();
console.log(data);

Exemplo de criação de recurso

const res = await fetch('https://api.vupi.us/api/task', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + access_token
    },
    body: JSON.stringify({
        nome: 'Minha nova tarefa'
    })
});
const { task } = await res.json();
// task = { id: '...', nome: 'Minha nova tarefa', criado_em: '...' }
Segurança

Nunca exponha o access_token no código-fonte do frontend. Use cookies HttpOnly quando possível. O token expira conforme configurado no .env (padrão: 1 hora).