My ID Virtual API

Bem-vindo à documentação oficial da API My ID Virtual. Esta é uma API REST completa desenvolvida em NestJS que oferece serviços de VPN, gerenciamento de usuários, processamento de pagamentos e muito mais.

Características Principais

Autenticação JWT

Sistema robusto de autenticação com JWT e OTP para máxima segurança

Gerenciamento de Usuários

Sistema completo de usuários com diferentes níveis de acesso (Admin, Reseller, Customer)

Serviços VPN

Gerenciamento completo de servidores VPN e configurações de cliente

Processamento de Pagamentos

Integração com sistemas de pagamento e webhooks

Arquitetura da API

A API é construída utilizando tecnologias modernas:
  • Framework: NestJS com TypeScript
  • Banco de Dados: TypeORM com PostgreSQL/MySQL
  • Autenticação: JWT com Guards customizados
  • Documentação: OpenAPI/Swagger integrado
  • Email: Sistema de envio com templates
  • Upload: Suporte a arquivos e imagens

Níveis de Acesso

Acesso completo ao sistema, pode gerenciar todos os recursos e usuários
Acesso de administração limitado, pode gerenciar revendedores e seus clientes
Acesso de revendedor, pode gerenciar apenas seus próprios clientes
Acesso de usuário final, pode gerenciar apenas seus próprios recursos

Make your first request

To make your first request, you’ll need an API key. You can get one from your dashboard.
curl --location --request GET 'http://localhost:3333/auth/me' \
--header 'Authorization: Bearer <token>'