Post access control entry authorize

Controle de Acesso - Autorização de Entrada

Descrição

Este endpoint é responsável por autorizar ou negar a entrada de uma pessoa em um dispositivo de controle de acesso (catraca, dispositivo manual, etc.).

📨 Parâmetros da Requisição (Request Body)

A autorização é baseada em informações do usuário (membro/prospect/visitante), regras de contrato/plano e condições adicionais (como temperatura, clima e dispositivo de entrada).

Parâmetro

Tipo

Obrigatório

Descrição

id

Inteiro

Sim

ID do usuário cadastrado no EVO.

personType

Inteiro

Sim

Tipo de pessoa que está acessando. Valores:

  • 1: Cliente
  • 2: Oportunidade
  • 3: Colaborador
  • 4: Personal

device

Inteiro

Sim

ID do dispositivo usado para o acesso. Valores:

  • 1: Digital
  • 2: QR Code
  • 3: Facial
  • 4: Teclado

idManualEntry

Inteiro

Não

ID da liberação manual registrada no EVO. Necessário em caso de liberação sem autenticação.

temperature

Decimal

Não

Temperatura no momento do acesso, em Celsius. Utilizado para o Clube de Recompensas.

climateId

Inteiro

Não

ID do clima no momento do acesso. Utilizado para o Clube de Recompensas. Valores:

  • 1: Ensolarado
  • 2: Frio
  • 3: Chuva
  • 4: Tempestades
  • 5: Neve
  • 6: Nublado
  • 7: Ventoso

idTurnstile

Inteiro

Sim

ID da catraca registrada no EVO.

📤 Estrutura da Resposta

O retorno indica se a entrada foi autorizada, além de trazer informações sobre o usuário, plano, status do acesso e detalhes da passagem.

CampoTipoDescrição
authorizedbooleanIndica se o acesso foi autorizado (true) ou negado (false).
messagestringMensagem padrão retornada pelo sistema (ex.: "Acesso autorizado", "Plano expirado").
messageCustomstringMensagem customizada configurada pela filial.
entryIdint32Identificador do registro da entrada no sistema.
photoUrlstringURL da foto do usuário, se disponível.
totalFitcoinsint32Pontos ou créditos de gamificação (ex.: fitcoins acumulados).
documentstringDocumento identificador do usuário (ex.: CPF, RG, passaporte).
planIdPassageint32Identificador do plano utilizado para validar a passagem.
planNamestringNome do plano ativo no momento da passagem.
namestringNome completo da pessoa identificada.
idint32Identificador da pessoa no sistema.
passageDirectionstringDireção da passagem (ex.: "Entrada", "Saída").
blockedtypeint32Código do motivo de bloqueio, caso o acesso tenha sido negado. Consultar a tabela de blockedType abaixo.
frequencyint32Número de acessos registrados no período configurado.
planExpirationstring(date-time)Data e hora de expiração do plano vigente.

Tipos de Bloqueios (blockedType)

CódigoDescrição
0Sem bloqueio
1Sem acesso a esta filial
2Bloqueio manual no cadastro
3Restrição manual no cadastro
4Sem acesso pelo dispositivo teclado
5Bloqueio por CREF vencido
6Bloqueio por contrato suspenso
7Contrato não permite acesso à catraca informada
8Quantidade de entradas configuradas no contrato esgotaram
9Acesso fora do horário permitido no contrato
10Acesso não agendado conforme exigido pelo contrato
11Usuário com saldo devedor
12Usuário sem exame médico
13Exame médico vencido
14Usuário sem exame nutricional
15Exame nutricional vencido
16Usuário sem exame dermatológico
17Exame dermatológico vencido
18Bloqueio por falta de avaliação física ou avaliação vencida
19Usuário Gympass não tem acesso à catraca informada
20Gympass: acesso permitido apenas na primeira hora do check-in
21Gympass: nenhum check-in encontrado
22Gympass: idade não permitida para o plano
23Gympass: acesso fora do horário permitido pelo produto
24Gympass: GYM-ID cadastrado no EVO é inválido
25Gympass: servidor indisponível
26Check-in do usuário foi cancelado
27Check-in do usuário expirou
28Check-in do usuário já validado anteriormente
29Check-in inválido para o respectivo plano Gympass
30Totalpass: nenhum check-in encontrado
31Totalpass: acesso permitido apenas na primeira hora do check-in
32Totalpass: check-in não disponível para validação
33Totalpass: check-in do usuário expirado
34Totalpass: dados do check-in não encontrados
35Totalpass: erro ao validar (servidor indisponível)
36Nenhum serviço disponível para acesso
37Convite de liberação não dá acesso à catraca informada
38Pendência de assinatura do contrato
39Termo de acesso não aceito pelo usuário
40PARQ: usuário sem preenchimento do formulário
41PARQ: pendência de upload de atestado
42Ocupação máxima da academia atingida
43Bloqueio por acesso duplo no tempo configurado
44Cliente sem plano ativo
45Totalpass: dados de configuração incompletos
46Colaborador sem acesso à filial
47Colaborador inativo
48Colaborador acessando fora do horário de trabalho
49Personal com contrato suspenso
50Contrato do personal não permite acesso à catraca informada
51Personal sem contrato ativo
52Oportunidade com tempo de visita vencido
53Oportunidade sem tempo de visita configurado

📝 Exemplo de Requisição (Request Body)

{
  "id": 1025,
  "personType": 1,
  "device": 12,
  "idManualEntry": 0,
  "temperature": 36.5,
  "climateId": 2,
  "idTurnstile": 5
}

✅ Exemplo de Resposta

{
  "authorized": true,
  "message": "string",
  "messageCustom": "string",
  "entryId": 0,
  "photoUrl": "string",
  "totalFitcoins": 0,
  "document": "string",
  "planIdPassage": 0,
  "planName": "string",
  "name": "string",
  "id": 0,
  "passageDirection": "string",
  "blockedtype": 0,
  "frequency": 0,
  "planExpiration": "2025-10-01T15:15:18.633Z"
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!