EVO API ES
Inicio
GuíasAPIs💎 API Pro📢 Novedades
Inicio
GuíasAPIs💎 API Pro📢 Novedades
  1. Primeros pasos con la API
  • ¡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 access control insert manual liberation
      • Get access control turnstiles
      • Update access control serial number turnstiles
    • 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. Primeros pasos con la API

API Pro

EVO ofrece integración vía API para clientes a partir de EVO Black, ofreciendo dos planes de uso: API Plus y API Pro.
Los planes definen límites de uso y reglas de consumo de la API.

➕ API Plus#

La EVO API Plus está incluida en la mensualidad de EVO Black, sin costos adicionales, y está indicada para integraciones puntuales o de bajo volumen.

Límites de uso#

Tipo de límiteCantidad
Límite diario100 solicitudes
Límite mensual1.000 solicitudes
El límite se aplica por unidad (sucursal). De esta forma, en academias que poseen múltiples unidades asociadas al mismo DNS, cada unidad tiene su propio conteo de solicitudes. Así, es posible que una unidad alcance su límite de solicitudes mientras las demás continúan realizando llamadas a la API normalmente, sin impacto en su funcionamiento.
🚧 OBS. Es posible monitorear este límite de uso directamente desde EVO en la ruta
Configuraciones > Integraciones > Card EVO API.
image.png

Comportamiento al alcanzar el límite#

Cuando uno de los límites sea alcanzado:
No se podrán realizar nuevas solicitudes.
Dependiendo de si se alcanzó el límite diario o mensual, la API devolverá el error a continuación.
{ 
  "status": 401, 
  "error": "Daily request limit reached. Upgrade to API Pro to get unlimited requests." 
}

Reglas de renovación de los límites:#

Límite diario: se reinicia automáticamente al inicio del siguiente día.
Límite mensual: se reinicia automáticamente al inicio del siguiente mes.

💎 API Pro#

La EVO API Pro es un plan opcional que puede contratarse directamente dentro de la plataforma EVO.
Este plan está indicado para integraciones de volumen medio o alto, ofreciendo mayor capacidad de uso y recursos adicionales.

Beneficios#

Solicitudes diarias ilimitadas
Mayor límite de solicitudes por minuto al utilizar el header de API Pro
Workshops exclusivos con especialistas
Posibilidad de configuración de webhooks personalizados directamente desde EVO (próximamente).
Acceso anticipado a nuevos recursos de la API.

Modelo de cobro#

El plan tiene una mensualidad base y un cobro adicional según el volumen de solicitudes.
Consulta el modelo de cobro en este artículo.

Períodos de cobro#

PeríodoHorario
Diurno06:00 a 23:59
Nocturno00:00 a 05:59
El cobro referente al uso se genera al final de cada mes, con vencimiento el día 15, independientemente de la fecha de contratación.

Cómo contratar la API PRO#

Puedes realizar esta contratación directamente desde EVO. Más información aquí.

Relación entre Planes y Rate Limits#

Los límites de uso de los planes no sustituyen los rate limits técnicos de la API.
Es decir:
API Plus tiene límites diario y mensual, además de los rate limits técnicos.
API Pro no tiene límite diario, mensual ni por minuto, pero continúa sujeto a los demás rate limits técnicos de la API.
Estos rate limits existen para proteger la infraestructura y garantizar la estabilidad de la plataforma para todos los clientes. Obtén más información sobre nuestros límites de solicitudes aquí.
Modificado en 2026-05-15 03:33:02
Anterior
Límites de solicitudes
Siguiente
Utilizar la documentación de forma eficaz
Built with