EVO API ES
Inicio
GuíasAPIs💎 API Pro📢 Novedades
Inicio
GuíasAPIs💎 API Pro📢 Novedades
  1. AccessControl
  • ¡Bienvenido 💜
  • 📃 Guías
    • Primeros pasos con la API
      • Primeros pasos con la EVO API
      • Permisos de token
      • Límites de solicitudes
      • API Pro
    • Comprender la documentación
      • Utilizar la documentación de forma eficaz
      • Novedades
    • Casos de uso
      • Realizar ventas online a través de API
      • Integración de EVO Pay
      • Cómo usar webhooks
      • Agendamiento de una clase experimental
      • Exportar llamadas a Excel
      • Conciliación de pagos bancarios
      • Emisión de factura
    • FAQ
      • Configuraciones e integraciones
      • Gestión de clientes y relaciones
      • Operación y actividades
      • Financiero
    • Sugerencias
      • Sugerencia de implementación
  • 🌐 API Reference
    • AccessControl
      • Post access control entry authorize
        POST
      • Post access control insert manual liberation
        POST
      • Get access control turnstiles
        GET
      • Update access control serial number turnstiles
        PUT
    • Activities
      • Get activities
      • Get activities schedule
      • Get activities schedule details
      • Enroll member in activity schedule
      • Change status of a member in activity schedule
      • Create a new experimental class and enroll the member on it
      • List of spots that are already filled in the activity session
      • Get activities schedule by idService or idMembership
      • Get activities enrollment by member or membership
      • Create a new enrollment for a member
      • Delete enrollment
      • Get enrollment details for a member
      • Book member in activity schedule
      • Change status of a member in activity schedule
      • Get activities schedule by enrollment
      • Create a new enrollment for a member
      • Delete enrollment
      • Get enrollment details for a member
      • Get activity sessions for a member
    • Appointments
      • Get activities
      • Retrieves detailed information about scheduled appointment sessions
      • Get blocked appointments
      • Get available activities for appointment
      • Get the available times for appointment
      • Change status of a member in a appointment
      • Enroll member in activity appointment
    • BankAccounts
      • Get bank accounts
    • Carts
      • Get cart by idCartToken
      • Get cart by idMember or idProspect
      • Add new cart
      • Forfeit cart
    • Configuration
      • Get branch configurations
      • Get gateway configurations
      • Get gateway form token
      • Get card flag
      • Get card translation
      • Get occupation
    • Employees
      • Get employees
      • Add employees
      • Update employees
      • Delete employees
      • Retrieves employee permissions.
    • Entries
      • Get entries
    • Invoices
      • Get invoices by date
    • Management
      • Get non-renewed clients
      • Get prospects
      • Get active clients
    • MemberMembership
      • Get summary of MemberMemberships (active, canceled, or specific types).
      • Get summary of MemberMemberships by id
      • Cancel MemberMembership
      • Revert scheduled membership cancellation.
    • Members
      • Get member profile
      • Get members
      • Retrieves active members from a specific branch or from all branches
      • Get member services
      • Get member credit cards
      • Update a member card number
      • Authenticate member
      • Get link for reset password
      • Update a member fitcoins
      • Get member fitcoins
      • Get basic member information.
      • Get member's latest branch transfer
      • Update basic member data
      • Transfers a member from one branch to another
      • Block/unblock member
      • Send push notification to a specific member
      • Send push notification to multiple members
    • Membership
      • Get memberships
      • Get memberships categories
    • Notifications
      • Insert a member notification
      • Insert a prospect notification
    • Parking
      • Validates parking access authorization by CPF (`document`) or by `idMember` for a specific branch.
    • Partnership
      • Get partnerships
    • Payables
      • Get payables
      • Get cost center
    • Pix
      • Get qr-code
    • Product
      • Get products
    • Prospects
      • Get prospects
      • Add prospects
      • Update prospect
      • Get prospect services
      • Transfers a prospect from one branch to another
      • Get prospect's latest branch transfer
      • Get interests list
      • Turn the opportunity into a member, returns the idMember created.
    • Receivables
      • Gets a list of debts and current status (Similar to the Collections - Default report)
      • Creates batch collection attempts for the member membership contracts.
      • Gets the details of a specific charge batch.
      • Get receivables
      • Marks a list of receivables as received (paid)
      • Reverses a list of received (paid) receivables back to open status
      • Get cost center
      • Get receivables conciliation report
      • Charge a receivable using a member's credit card
    • Sales
      • Get sale by Id
      • Get sales
      • Create a new sale
      • Get sales bySessionId
      • Return itens for sale -> site/totem
    • Service
      • Get services
    • States
      • Get all states for the current user's country
    • Voucher
      • Get vouchers
      • Get all vouchers code by voucher id
      • Creates a new voucher
      • Validate the voucher
    • Webhook
      • Add new webhook
      • Remove a specific webhook by id
      • List all webhooks created
      • List all webhooks created
    • Workout
      • Change data from a client's prescribed workout
      • Get all Exercises
      • Get all default workouts of the new prescription
      • Get all client's or prospect's or employee's workouts of the new prescription
      • Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
      • Link workout of the new prescription for client
      • Create a workout of the new prescription
  • Schemas
    • Schemas
      • ClientesAtivosViewModel
      • ContratoNaoRenovadosViewModel
      • SpsRelProspectsCadastradosConvertidos
    • ActiveMembersReturnViewModel
    • ActivityAreaViewModel
    • ActivityEmployeesViewModel
    • ActivityGroupApiViewModel
    • ActivityGroupViewModel
    • ActivityResourcesViewModel
    • ActivityUnavailability
    • AreaBloqueioAgendaApiViewModel
    • AtividadeAgendaApiCustomViewModel
    • AtividadeAgendaApiViewModel
    • AtividadeAgendaListApiViewModel
    • AtividadeBasicoApiViewModel
    • AtividadeEnrollScheduleApiV2ViewModel
    • AtividadeListApiViewModel
    • AddressFamily
    • AtividadeLugarReservaApiViewModel
    • AtividadeLugarReservaViewModel
    • AtividadeSessaoAgendaViewModel
    • AtividadeSessaoParticipanteApiViewModel
    • AsnEncodedData
    • BairroViewModel
    • BandeirasBasicoViewModel
    • Assembly
    • BankAccountsViewModel
    • BasicFreezeViewModel
    • AsymmetricAlgorithm
    • BasicMemberMembershipApiViewModel
    • BloqueioAgendaApiViewModel
    • BonusSessionViewModel
    • BranchGatewayViewModel
    • BusinessHoursViewModel
    • CardDataViewModel
    • CardTranslationViewModel
    • CartIdViewModel
    • CartItemsViewModel
    • CartViewModel
    • ChargeReceivableRequestViewModel
    • ChargeReceivableResponseViewModel
    • CidadeViewModel
    • CityViewModel
    • ClienteDetalhesBasicosApiViewModel
    • ClienteEnotasRetorno
    • ClienteTransferenciaViewModel
    • CofinsEnotasRetorno
    • ColaboradoresBloqueioAgendaApiViewModel
    • ClientesAtivosRetornoViewModel
    • ConfiguracaoApiViewModel
    • ConjugadoItemRequestApiViewModel
    • ContratoEntradasApiViewModel
    • ByteReadOnlyMemory
    • ContratoFiliaisResumoApiViewModel
    • ContratosCanceladosParcelasApiViewModel
    • ByteReadOnlySpan
    • ContratosCanceladosResumoApiViewModel
    • ContratosResumoApiViewModel
    • CallingConventions
    • ContratosResumoPaginaVendaViewModel
    • ConveniosApiViewModel
    • CancellationToken
    • CostCenterApiViewModel
    • DadosContratoTrasnferenciaApiViewModel
    • DadosTrocaContratoApiViewModel
    • DebtorChargesViewModel
    • DebtorsItensViewModel
    • DefaultResponseViewModel
    • DiferenciaisApiViewModel
    • DifferentialsViewModel
    • DropsetItemRequestApiViewModel
    • EFormaContato
    • Claim
    • EFormaPagamentoTotem
    • EOrigemAgendamento
    • ClaimsIdentity
    • EStatusAtividade
    • EStatusAtividadeSessao
    • ClaimsPrincipal
    • ESubStatus
    • ESubStatusApi
    • ETemperatura
    • ETipoContrato
    • ETipoDocumento
    • ETipoGateway
    • EmployeeApiBranchPermissions
    • EmployeeApiIntegracaoAtualizacaoViewModel
    • EmployeeApiIntegracaoViewModel
    • EmpresasConveniosApiViewModel
    • ConnectionInfo
    • EmpresasFiliaisOcupacaoViewModel
    • EnderecoEnotasRetorno
    • ConstructorInfo
    • EnotasRetorno
    • EntradasResumoApiViewModel
    • ExperimentalClassResponseViewModel
    • FitcoinsResponseViewModel
    • FreezeViewModel
    • FreteEnotasRetorno
    • FuncionariosResumoApiViewModel
    • HttpResponseError
    • IcmsEnotasRetorno
    • IdMemberResponseViewModel
    • EmpresasFiliaisGatewayViewModel
    • ImpostosEnotasRetorno
    • InformacoesIndicadosViewModel
    • InstallmentViewModel
    • ItenEnotasRetorno
    • CustomAttributeData
    • ItensBloqueioAgendaApiViewModel
    • LiberacaoCatracaManualViewModel
    • CustomAttributeNamedArgument
    • LogTefApiViewModel
    • MatriculaDetalhesApiV2ViewModel
    • CustomAttributeTypedArgument
    • MatriculaDetalhesApiViewModel
    • EstadoViewModel
    • MatricularApiViewModel
    • MatricularConfiguracaoApiViewModel
    • MemberAuthenticateViewModel
    • MemberBasicResponsibleViewModel
    • MemberBlockUnblockViewModel
    • MemberCreditCardApiViewModel
    • MemberDataViewModel
    • MemberLevelViewModel
    • MemberMembershipApiViewModel
    • MemberNewSaleViewModel
    • MemberParkingViewModel
    • MemberResponsibleViewModel
    • MemberScheduleApiV2ViewModel
    • MemberServiceViewModel
    • MemberTransferViewModel
    • MembersApiResumidoVendaViewModel
    • MembersApiViewModel
    • MembersBasicApiViewModel
    • MetadadosEnotasRetorno
    • MobilePushMultiplaViewModel
    • MobilePushViewModel
    • MonthDiscountViewModel
    • NeighborhoodViewModel
    • NewSaleViewModel
    • NotificationApiViewModel
    • NotificationProspectApiViewModel
    • NotificationResponseViewModel
    • NovoVoucherViewModel
    • PagamentoEnotasRetorno
    • PayablesApiSubTypesViewModel
    • PayablesApiViewModel
    • PedidoEnotasRetorno
    • PercentualAproximadoTributosEnotasRetorno
    • PeriodizacaoApiViewModel
    • EventAttributes
    • PisEnotasRetorno
    • PixPaymentDetailsViewModel
    • EventInfo
    • PrescricaoTreinoViewModel
    • ProblemDetails
    • ProdutoResumoApiViewModel
    • FieldAttributes
    • ProgressivoItemRequestApiViewModel
    • ProspectApiIntegracaoAtualizacaoViewModel
    • FieldInfo
    • ProspectApiIntegracaoViewModel
    • ProspectIdViewModel
    • ProspectResponsavelFinanceiroViewmodel
    • ProspectTransferViewModel
    • ProspectTransferenciaViewModel
    • ProspectsResumoApiViewModel
    • GenericParameterAttributes
    • ProtocoloEnotasRetorno
    • PublicoAtividadeViewModel
    • HostString
    • ReceivablesApiResumoVendaViewModel
    • ReceivablesApiSubTypesViewModel
    • HttpContext
    • ReceivablesApiViewModel
    • ReceivablesApiViewModelListGridComQtdeViewModel
    • HttpRequest
    • ReceivablesCreditDetails
    • ReceivablesInvoiceApiViewModel
    • HttpResponse
    • ReceivablesMaskReceivedViewModel
    • RecursosBloqueioAgendaApiViewModel
    • RetornoCatracaViewModel
    • ICustomAttributeProvider
    • RetornoEntradaManualViewModel
    • RevenueCenterApiViewModel
    • IIdentity
    • ReverseReceivedResponseViewModel
    • ReverseReceivedViewModel
    • IPAddress
    • SaleItensViewModel
    • SalesItemViewModel
    • SalesItemsViewModel
    • IResponseCookies
    • SalesViewModelV2
    • SerieItemRequestApiViewModel
    • IServiceProvider
    • SeriePrescricaoRequestApiViewModel
    • ServiceDiscountViewModel
    • ISession
    • ServicoAdicionalApiViewModel
    • ServicoAnualApiViewModel
    • ServicoEnotasRetorno
    • ServicosResumoApiViewModel
    • SimplificadoEnotasRetorno
    • SpsProspectsServicosInteresses
    • StateViewModel
    • SumaryDebtorsViewModel
    • IntPtr
    • TaxDataViewModel
    • TelefoneApiViewModel
    • TransferClientResponseViewModel
    • TransporteEnotasRetorno
    • KeySizes
    • TreinoPrescricaoRequestApiViewModel
    • UnavailableSpotsResponseViewModel
    • LayoutKind
    • VendasResumoApiViewModel
    • VoucherAtributePublicViewModel
    • VoucherCriacaoViewModel
    • VoucherItemApiViewModel
    • VouchersCodigosViewModel
    • SalesViewModel
    • VouchersCodigosViewModelListWithQuantityViewModel
    • VouchersResumoApiViewModel
    • W12UtilsCategoryMembershipViewModel
    • W12UtilsWebhookHeaderViewModel
    • W12UtilsWebhookViewModel
    • W12UtilzWebHookFilterViewModel
    • YearDiscountViewModel
    • autorizaEntradaExternoViewModel
    • retornoAutorizaEntradaExternoViewModel
    • MemberInfo
    • MemberTypes
    • MethodAttributes
    • MethodBase
    • TimeSpan
    • MethodImplAttributes
    • MethodInfo
    • Module
    • ModuleHandle
    • Oid
    • ParameterAttributes
    • ParameterInfo
    • PathString
    • PipeReader
    • PipeWriter
    • PropertyAttributes
    • PropertyInfo
    • PublicKey
    • QueryString
    • RuntimeFieldHandle
    • RuntimeMethodHandle
    • RuntimeTypeHandle
    • SafeWaitHandle
    • SecurityRuleSet
    • Stream
    • StringStringKeyValuePair
    • StringStringValuesKeyValuePair
    • StructLayoutAttribute
    • Type
    • TypeAttributes
    • TypeInfo
    • TypeObjectKeyValuePair
    • WaitHandle
    • WebSocketManager
    • X500DistinguishedName
    • X509Certificate2
    • X509Extension
  1. AccessControl

Post access control entry authorize

POST
https://evo-integracao-api.w12app.com.br/api/v2/accessControl/entryAuthorize
🌐 API Reference/AccessControl

Control de Acceso - Autorización de Entrada#

Descripción#

Este endpoint es responsable de autorizar o denegar la entrada de una persona en un dispositivo de control de acceso (torniquete, dispositivo manual, etc.).
🛂 El permiso en EVO que habilita el acceso a este endpoint es Control de Acceso - Consulta.

📨 Parámetros de la Solicitud (Request Body)#

La autorización se basa en información del usuario (miembro/prospecto/visitante), reglas de contrato/plan y condiciones adicionales (como temperatura, clima y dispositivo de entrada).
OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.
ParámetroTipoObligatorioDescripción
idint32SíID del usuario registrado en EVO.
personTypeint32SíTipo de persona que está accediendo. Valores: 1: Cliente, 2: Oportunidad, 3: Colaborador, 4: Personal
deviceint32SíID del dispositivo utilizado para el acceso. Valores: 1: Digital, 2: QR Code, 3: Facial, 4: Teclado
idManualEntryint32NoID de la liberación manual registrada en EVO. Necesario en caso de liberación sin autenticación.
temperatureDecimalNoTemperatura en el momento del acceso, en Celsius. Utilizado para el Club de Recompensas.
climateIdint32NoID del clima en el momento del acceso. Utilizado para el Club de Recompensas. Valores: 1: Soleado, 2: Frío, 3: Lluvia, 4: Tormenta, 5: Nieve, 6: Nublado, 7: Ventoso
idTurnstileint32SíID del torniquete registrado en EVO.

📤 Estructura de la Respuesta#

La respuesta indica si la entrada fue autorizada, además de proporcionar información sobre el usuario, el plan, el estado del acceso y detalles del registro de entrada.
CampoTipoDescripción
authorizedbooleanIndica si el acceso fue autorizado (true) o denegado (false).
messagestringMensaje estándar devuelto por el sistema (ej.: "Acceso autorizado", "Plan expirado").
messageCustomstringMensaje personalizado configurado por la sucursal.
entryIdint32Identificador del registro de entrada en el sistema.
photoUrlstringURL de la foto del usuario, si está disponible.
totalFitcoinsint32Puntos o créditos de gamificación (ej.: fitcoins acumulados).
documentstringDocumento identificador del usuario (ej.: CPF, RG, pasaporte).
planIdPassageint32Identificador del plan utilizado para validar el acceso.
planNamestringNombre del plan activo en el momento del acceso.
namestringNombre completo de la persona identificada.
idint32Identificador de la persona en el sistema.
passageDirectionstringDirección del paso (ej.: "Entrada", "Salida").
blockedtypeint32Código del motivo de bloqueo si el acceso fue denegado. Consultar la tabla blockedType a continuación.
frequencyint32Número de accesos registrados en el período configurado.
planExpirationstring(date-time)Fecha y hora de expiración del plan vigente.

Tipos de Bloqueo blockedType#

CódigoDescripción
0Sin bloqueo
1Sin acceso a esta sucursal
2Bloqueo manual en el registro
3Restricción manual en el registro
4Sin acceso mediante dispositivo de teclado
5Bloqueo por CREF vencido
6Bloqueo por contrato suspendido
7El contrato no permite acceso al torniquete informado
8La cantidad de entradas configuradas en el contrato se ha agotado
9Acceso fuera del horario permitido en el contrato
10Acceso no programado según lo exigido por el contrato
11Usuario con saldo pendiente
12Usuario sin examen médico
13Examen médico vencido
14Usuario sin examen nutricional
15Examen nutricional vencido
16Usuario sin examen dermatológico
17Examen dermatológico vencido
18Bloqueo por falta de evaluación física o evaluación vencida
19Usuario Gympass no tiene acceso al torniquete informado
20Gympass: acceso permitido solo en la primera hora del check-in
21Gympass: ningún check-in encontrado
22Gympass: edad no permitida para el plan
23Gympass: acceso fuera del horario permitido por el producto
24Gympass: GYM-ID registrado en EVO es inválido
25Gympass: servidor no disponible
26Check-in del usuario fue cancelado
27Check-in del usuario expiró
28Check-in del usuario ya validado anteriormente
29Check-in inválido para el respectivo plan Gympass
30Totalpass: ningún check-in encontrado
31Totalpass: acceso permitido solo en la primera hora del check-in
32Totalpass: check-in no disponible para validación
33Totalpass: check-in del usuario expirado
34Totalpass: datos del check-in no encontrados
35Totalpass: error al validar (servidor no disponible)
36Ningún servicio disponible para acceso
37La invitación de liberación no permite acceso al torniquete informado
38Pendiente de firma del contrato
39Término de acceso no aceptado por el usuario
40PARQ: usuario sin completar el formulario
41PARQ: pendiente de subida de certificado
42Ocupación máxima del gimnasio alcanzada
43Bloqueo por acceso duplicado dentro del tiempo configurado
44Cliente sin plan activo
45Totalpass: datos de configuración incompletos
46Colaborador sin acceso a la sucursal
47Colaborador inactivo
48Colaborador accediendo fuera del horario laboral
49Personal con contrato suspendido
50El contrato del personal no permite acceso al torniquete informado
51Personal sin contrato activo
52Oportunidad con tiempo de visita vencido
53Oportunidad sin tiempo de visita configurado

📝 Ejemplo de Solicitud (Request Body)#

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

Solicitud

Autorización
or
Parámetros del Body
application/json-patch+json

Ejemplos

Respuestas

🟢200OK
application/json
Success
Body

🟠400Bad Request
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v2/accessControl/entryAuthorize' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "id": 0,
    "personType": 0,
    "device": 0,
    "idManualEntry": 0,
    "temperature": 0,
    "climateId": 0,
    "idTurnstile": 0
}'
Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
{
    "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": "2019-08-24T14:15:22.123Z"
}
Modificado en 2026-05-15 13:34:34
Anterior
AccessControl
Siguiente
Post access control insert manual liberation
Built with