API REST
Integre o Meu Atendimento Virtual ao seu sistema com nossa API REST completa.
API REST
43 endpoints organizados em 13 recursos para controle total da plataforma.
Token Authentication
Autenticação via Bearer Token com suporte a JWT e sessão.
Paginação
Todas as listagens suportam paginação com page e page_size.
JSON Nativo
Requisições e respostas em JSON com schemas bem definidos.
Recursos Disponíveis
13 recursos com 43 endpoints para controle total da plataforma
Tickets
Emita, chame, cancele e acompanhe senhas de atendimento.
8 endpointsServiços
Gerencie serviços, códigos de senha e usuários vinculados.
7 endpointsClientes
Cadastre e consulte clientes por CPF, e-mail ou telefone.
5 endpointsLocais
Configure guichês, salas e pontos de atendimento.
4 endpointsAgendamentos
Crie e gerencie agendamentos integrados às filas.
4 endpointsTotens
Configure telas de autoatendimento e quiosques.
4 endpointsUsuários
Gerencie operadores, gerentes e perfis de acesso.
4 endpointsConfigurações
Ajuste QR code, impressão de senhas e cores do painel.
2 endpointsEndpoints Principais
Exemplos dos endpoints mais utilizados na integração
| Método | Endpoint | Descrição |
|---|---|---|
| POST | /api/v1/autenticacao/ | Autenticar e obter token de acesso |
| GET | /api/v1/servicos/ | Listar serviços de atendimento |
| POST | /api/v1/tickets/ | Emitir nova senha para a fila |
| POST | /api/v1/tickets/call_ticket/ | Chamar próxima senha no ponto de atendimento |
| POST | /api/v1/tickets/start_attendance/ | Iniciar atendimento de uma senha |
| GET | /api/v1/queues/tickets/ | Listar senhas em espera por serviço |
| GET | /api/v1/clientes/ | Buscar clientes por CPF, e-mail ou telefone |
| GET | /api/v1/locais/ | Listar pontos de atendimento (guichês, salas) |
Integração Rápida
Emita senhas e gerencie filas com poucas linhas de código. Autentique-se com seu token e comece a usar a API.
- Autenticação via Bearer Token
- Respostas em JSON
- Paginação em todas as listagens
- Filtros por CPF, e-mail, status e mais
# Autenticar e obter token
curl -X POST \
https://painel.meuatendimentovirtual.com.br/api/v1/autenticacao/ \
-H "Content-Type: application/json" \
-d '{"email": "seu@email.com", "password": "sua_senha"}'
# Emitir uma nova senha
curl -X POST \
https://painel.meuatendimentovirtual.com.br/api/v1/tickets/ \
-H "Authorization: Token SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"services": [{"service_key": "CHAVE_DO_SERVICO"}],
"priority_name": "normal"
}'
# Chamar próxima senha no guichê
curl -X POST \
https://painel.meuatendimentovirtual.com.br/api/v1/tickets/call_ticket/ \
-H "Authorization: Token SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{"service_point_key": "CHAVE_DO_GUICHE"}'const API_URL = 'https://painel.meuatendimentovirtual.com.br/api/v1';
// Autenticar
const auth = await fetch(`${API_URL}/autenticacao/`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
email: 'seu@email.com',
password: 'sua_senha'
})
});
const { token } = await auth.json();
// Listar serviços disponíveis
const services = await fetch(`${API_URL}/servicos/`, {
headers: { 'Authorization': `Token ${token}` }
});
const { results } = await services.json();
// Emitir senha para o primeiro serviço
const ticket = await fetch(`${API_URL}/tickets/`, {
method: 'POST',
headers: {
'Authorization': `Token ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
services: [{ service_key: results[0].key }],
priority_name: 'normal'
})
});
const senha = await ticket.json();
console.log(`Senha emitida: ${senha.code}`);Exemplo com JavaScript
Use fetch ou qualquer cliente HTTP para integrar. Sem necessidade de SDKs
ou bibliotecas adicionais.
- Funciona com qualquer linguagem
- Sem dependências externas
- Documentação interativa disponível
Pronto para integrar?
Crie sua conta gratuita e obtenha seu token de API em minutos.