​
API Reference

Bem-vindo à referência completa da API My ID Virtual. Esta seção contém documentação detalhada de todos os endpoints disponíveis, organizados por funcionalidade.

​
Base URL

http://localhost:3333
Em produção, substitua por https://api.myidvirtual.com

​
Autenticação

A maioria dos endpoints requer autenticação via JWT token: 
Authorization: Bearer <seu_jwt_token>

​
Estrutura da Documentação

Cada endpoint é documentado com:
  • Método HTTP e URL
  • Parâmetros de entrada (path, query, body)
  • Códigos de resposta possíveis
  • Exemplos de requisição e resposta
  • Requisitos de autenticação e permissões

​
Módulos da API

Autenticação

Login, registro, OTP e gerenciamento de tokens

Usuários

CRUD de usuários e gerenciamento de perfis

Clientes

Gerenciamento de clientes VPN

Servidores

Configuração e gerenciamento de servidores VPN

Serviços VPN

Contas VPN e configurações de conexão

Pagamentos

Pagamentos e autopay

Transações

Pagamentos e histórico financeiro

Webhooks

Configuração de webhooks e notificações

Email

Sistema de envio de emails

Arquivos

Gerenciamento de arquivos e documentos

Revendedores

Sistema de revenda e hierarquia

Administrativo

Dashboard, logs e ferramentas admin

​
Recursos Especiais

​
Rate Limiting

A API implementa limitação de taxa para proteger contra abuso. Consulte os headers de resposta: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1642234800

​
Paginação

Endpoints que retornam listas suportam paginação: 
GET /endpoint?page=1&limit=10&sort=created_at&order=desc

​
Filtros

Muitos endpoints suportam filtros avançados: 
GET /users/filter?role=CUSTOMER&status=ACTIVE&created_after=2024-01-01

​
Upload de Arquivos

Alguns endpoints suportam upload de arquivos: 
Content-Type: multipart/form-data

​
Códigos de Status

CódigoSignificado
200Sucesso
201Recurso criado
400Requisição inválida
401Não autenticado
403Sem permissão
404Não encontrado
422Dados inválidos
500Erro interno

​
Versionamento

Atualmente na versão 1. Futuras versões serão indicadas no URL: 
/v2/endpoint

​
Documentação Interativa

Acesse a documentação interativa em:
  • Swagger UI: http://localhost:3333/swagger
  • OpenAPI Spec: http://localhost:3333/openapi

​
Suporte

Para suporte técnico:
Use a documentação interativa do Swagger para testar endpoints diretamente no navegador.