EVO API EN
Home
GuidesAPIs💎 API Pro📢 News
Home
GuidesAPIs💎 API Pro📢 News
  1. Primeiros passos com a API
  • Welcome 💜
  • 📃 Guias
    • Primeiros passos com a API
      • Começando a usar a EVO API
      • Permissões do token
      • Limites de requisições
      • API Pro
    • Conhecendo a documentação
      • Utilizar a documentação de forma eficaz
      • Novidades
    • Casos de uso
      • Realizar venda online via API
      • Integração EVO Pay
      • Como usar o webhook
      • Agendamento de aula experimental
      • Chamadas de exportação para Excel
      • Conciliação de pagamentos via banco
      • Emissão de Nota Fiscal
      • Controle de acesso de aluno via serviço externo
      • Integrar landing page
    • FAQ
      • Gestão de clientes e relacionamentos
      • Operações e atividades
      • Financeiro
      • Configurações e integrações
    • Sugestões
      • Sugestão de implementação
  • 🌐 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
      • 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
      • 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.
      • Validates parking access authorization and information by CPF (`document`)
    • 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
    • ActivityGroupApiViewModel
    • ActivityAreaViewModel
    • ActiveMembersReturnViewModel
    • AtividadeAgendaApiViewModel
    • ActivityEmployeesViewModel
    • ActivityGroupViewModel
    • AtividadeBasicoApiViewModel
    • AtividadeAgendaApiCustomViewModel
    • ActivityResourcesViewModel
    • AtividadeListApiViewModel
    • ActivityUnavailability
    • AddressFamily
    • AtividadeLugarReservaApiViewModel
    • AreaBloqueioAgendaApiViewModel
    • AtividadeLugarReservaViewModel
    • AsnEncodedData
    • AtividadeSessaoParticipanteApiViewModel
    • AtividadeAgendaListApiViewModel
    • BairroViewModel
    • Assembly
    • AsymmetricAlgorithm
    • BandeirasBasicoViewModel
    • BankAccountsViewModel
    • BasicFreezeViewModel
    • AtividadeEnrollScheduleApiV2ViewModel
    • BasicMemberMembershipApiViewModel
    • AtividadeSessaoAgendaViewModel
    • BonusSessionViewModel
    • BusinessHoursViewModel
    • CardDataViewModel
    • CardTranslationViewModel
    • CartIdViewModel
    • CartItemsViewModel
    • CartViewModel
    • CidadeViewModel
    • BloqueioAgendaApiViewModel
    • ClienteDetalhesBasicosApiViewModel
    • ClienteEnotasRetorno
    • BranchGatewayViewModel
    • ClienteTransferenciaViewModel
    • ClientesAtivosRetornoViewModel
    • CofinsEnotasRetorno
    • ByteReadOnlyMemory
    • ConfiguracaoApiViewModel
    • ByteReadOnlySpan
    • ContratoEntradasApiViewModel
    • CallingConventions
    • ContratoFiliaisResumoApiViewModel
    • CityViewModel
    • CancellationToken
    • ChargeReceivableRequestViewModel
    • ContratosCanceladosParcelasApiViewModel
    • ChargeReceivableResponseViewModel
    • ContratosCanceladosResumoApiViewModel
    • ContratosResumoApiViewModel
    • ContratosResumoPaginaVendaViewModel
    • ColaboradoresBloqueioAgendaApiViewModel
    • ConveniosApiViewModel
    • CostCenterApiViewModel
    • ConjugadoItemRequestApiViewModel
    • Claim
    • DadosContratoTrasnferenciaApiViewModel
    • ClaimsIdentity
    • DadosTrocaContratoApiViewModel
    • ClaimsPrincipal
    • DebtorChargesViewModel
    • DebtorsItensViewModel
    • DefaultResponseViewModel
    • DiferenciaisApiViewModel
    • DifferentialsViewModel
    • EFormaContato
    • EFormaPagamentoTotem
    • EOrigemAgendamento
    • EStatusAtividade
    • ConnectionInfo
    • EStatusAtividadeSessao
    • ConstructorInfo
    • ETemperatura
    • ETipoContrato
    • ETipoDocumento
    • ETipoGateway
    • DropsetItemRequestApiViewModel
    • EmployeeApiIntegracaoAtualizacaoViewModel
    • EmployeeApiBranchPermissions
    • EmployeeApiIntegracaoViewModel
    • EmpresasConveniosApiViewModel
    • ESubStatus
    • EmpresasFiliaisGatewayViewModel
    • EmpresasFiliaisOcupacaoViewModel
    • ESubStatusApi
    • CustomAttributeData
    • EnderecoEnotasRetorno
    • CustomAttributeNamedArgument
    • EnotasRetorno
    • CustomAttributeTypedArgument
    • EntradasResumoApiViewModel
    • EstadoViewModel
    • ExperimentalClassResponseViewModel
    • FitcoinsResponseViewModel
    • FreezeViewModel
    • FreteEnotasRetorno
    • FuncionariosResumoApiViewModel
    • HttpResponseError
    • IcmsEnotasRetorno
    • ImpostosEnotasRetorno
    • InformacoesIndicadosViewModel
    • InstallmentViewModel
    • ItenEnotasRetorno
    • LiberacaoCatracaManualViewModel
    • LogTefApiViewModel
    • MemberAuthenticateViewModel
    • MemberBasicResponsibleViewModel
    • MemberBlockUnblockViewModel
    • MemberDataViewModel
    • MemberMembershipApiViewModel
    • MemberNewSaleViewModel
    • MemberResponsibleViewModel
    • IdMemberResponseViewModel
    • MemberServiceViewModel
    • MemberTransferViewModel
    • ItensBloqueioAgendaApiViewModel
    • MembersApiViewModel
    • MembersBasicApiViewModel
    • MetadadosEnotasRetorno
    • MonthDiscountViewModel
    • NewSaleViewModel
    • MatriculaDetalhesApiV2ViewModel
    • NotificationApiViewModel
    • MatricularApiViewModel
    • EventAttributes
    • NotificationProspectApiViewModel
    • MatricularConfiguracaoApiViewModel
    • EventInfo
    • NotificationResponseViewModel
    • NovoVoucherViewModel
    • FieldAttributes
    • PagamentoEnotasRetorno
    • FieldInfo
    • PayablesApiSubTypesViewModel
    • PayablesApiViewModel
    • PedidoEnotasRetorno
    • PercentualAproximadoTributosEnotasRetorno
    • MemberCreditCardApiViewModel
    • ReceivablesApiResumoVendaViewModel
    • PeriodizacaoApiViewModel
    • GenericParameterAttributes
    • PisEnotasRetorno
    • HostString
    • PixPaymentDetailsViewModel
    • HttpContext
    • PrescricaoTreinoViewModel
    • MembersApiResumidoVendaViewModel
    • MemberScheduleApiV2ViewModel
    • HttpRequest
    • ProblemDetails
    • HttpResponse
    • ProspectApiIntegracaoAtualizacaoViewModel
    • ProspectApiIntegracaoViewModel
    • ICustomAttributeProvider
    • ProspectIdViewModel
    • IIdentity
    • ProspectResponsavelFinanceiroViewmodel
    • IPAddress
    • ProspectTransferViewModel
    • NeighborhoodViewModel
    • IResponseCookies
    • ProspectTransferenciaViewModel
    • IServiceProvider
    • ProspectsResumoApiViewModel
    • ISession
    • ProtocoloEnotasRetorno
    • PublicoAtividadeViewModel
    • ReceivablesApiSubTypesViewModel
    • ReceivablesApiViewModel
    • ReceivablesApiViewModelListGridComQtdeViewModel
    • ReceivablesCreditDetails
    • IntPtr
    • ReceivablesInvoiceApiViewModel
    • VendasResumoApiViewModel
    • ProgressivoItemRequestApiViewModel
    • ReceivablesMaskReceivedViewModel
    • RetornoCatracaViewModel
    • KeySizes
    • RetornoEntradaManualViewModel
    • LayoutKind
    • RevenueCenterApiViewModel
    • SaleItensViewModel
    • SalesItemViewModel
    • SalesItemsViewModel
    • MatriculaDetalhesApiViewModel
    • SalesViewModel
    • ProdutoResumoApiViewModel
    • ServiceDiscountViewModel
    • ServicoAdicionalApiViewModel
    • ServicoAnualApiViewModel
    • ServicoEnotasRetorno
    • ServicosResumoApiViewModel
    • RecursosBloqueioAgendaApiViewModel
    • MemberInfo
    • SimplificadoEnotasRetorno
    • SpsProspectsServicosInteresses
    • MemberLevelViewModel
    • SumaryDebtorsViewModel
    • TaxDataViewModel
    • MemberParkingViewModel
    • TelefoneApiViewModel
    • TransferClientResponseViewModel
    • TransporteEnotasRetorno
    • MemberTypes
    • UnavailableSpotsResponseViewModel
    • VouchersResumoApiViewModel
    • W12UtilsCategoryMembershipViewModel
    • SerieItemRequestApiViewModel
    • W12UtilsWebhookHeaderViewModel
    • SeriePrescricaoRequestApiViewModel
    • MethodAttributes
    • W12UtilsWebhookViewModel
    • MethodBase
    • W12UtilzWebHookFilterViewModel
    • MethodImplAttributes
    • YearDiscountViewModel
    • TimeSpan
    • MethodInfo
    • autorizaEntradaExternoViewModel
    • ReverseReceivedResponseViewModel
    • retornoAutorizaEntradaExternoViewModel
    • MobilePushMultiplaViewModel
    • ReverseReceivedViewModel
    • MobilePushViewModel
    • Module
    • ModuleHandle
    • SalesViewModelV2
    • TreinoPrescricaoRequestApiViewModel
    • Oid
    • VoucherCriacaoViewModel
    • StateViewModel
    • ParameterAttributes
    • VouchersCodigosViewModel
    • ParameterInfo
    • VouchersCodigosViewModelListWithQuantityViewModel
    • PathString
    • PipeReader
    • VoucherAtributePublicViewModel
    • PipeWriter
    • VoucherItemApiViewModel
    • PropertyAttributes
    • PropertyInfo
    • PublicKey
    • QueryString
    • RuntimeFieldHandle
    • RuntimeMethodHandle
    • RuntimeTypeHandle
    • SafeWaitHandle
    • SecurityRuleSet
    • Stream
    • StringStringKeyValuePair
    • StringStringValuesKeyValuePair
    • StructLayoutAttribute
    • Type
    • TypeAttributes
    • TypeInfo
    • TypeObjectKeyValuePair
    • WaitHandle
    • WebSocketManager
    • X500DistinguishedName
    • X509Certificate2
    • X509Extension
  1. Primeiros passos com a API

Limites de requisições

Visão Geral#

Para proteger o sistema da academia contra problemas de desempenho durante o uso normal do EVO, as APIs seguem um sistema de rate limits (limitação de requisições). Essas restrições garantem que o ambiente permaneça estável, mesmo sob alta carga de uso.
Os critérios de rate limits estão descritos abaixo:

Critérios de Limite de Requisições#

1. Limite por Segundo (por IP)#

Limite: 5 requisições por segundo para o mesmo IP.
Comportamento após o limite ser atingido:
Retorno com status code 429 (Too Many Requests).
Aguardar 1 segundo antes de realizar novas requisições.

2. Limite por Minuto (por IP)#

Limite: 40 requisições por minuto para o mesmo IP.
Comportamento após o limite ser atingido:
Retorno com status code 429 (Too Many Requests).
Aguardar 1 minuto antes de realizar novas requisições.
💎 Clientes da API PRO não possuem o limite por minuto.

3. Limite por Hora (por Chave de API)#

Limite: 10.000 requisições por hora para a mesma chave de API.
Comportamento após o limite ser atingido:
A chave de API ficará bloqueada por 1 hora.
Retorno com status code 429 (Too Many Requests).
Detalhes:
O bloqueio é aplicado à chave específica, independente do IP que realizou as requisições.
Todas as requisições feitas com essa chave contam para o limite.

4. Rate Limit por Hora (por DNS da Academia)#

Limite: 20.000 requisições por hora para o mesmo DNS da academia.
Comportamento após o limite ser atingido:
Todas as chaves vinculadas ao DNS da academia ficarão bloqueadas por 1 hora.
Retorno com status code 429 (Too Many Requests).
Detalhes:
O bloqueio é aplicado à academia (validado pelo DNS), independente do IP ou chave de API utilizada.
Todas as requisições feitas pela academia contam para o limite.

Janela de Isenção de Limites#

Horário: Das 0h até 5h.
Durante este período, não há aplicação de limites quanto a quantidade de requisições por hora, por DNS ou IP. No entanto, o limite de requisições por segundo e por minuto permanece ativo. Ou seja, é possível realizar requisições em maior volume sem que esses limites sejam aplicados, mas ainda estarão em vigor a restrição de quantidade de requisições por segundo e por minuto.
Requisições em lote podem ser realizadas durante este período.
Operações que demandem alto volume de requisições podem aproveitar essa janela.

Resumo dos Limites#

Tipo de LimiteLimiteBloqueioStatus Code
Por Segundo (por IP)5 requisiçõespor 1s429
Por Minuto (por IP)40 requisiçõespor 1m429
Por Hora (por Chave)10.000 requisiçõespor 1h429
Por Hora (por DNS)20.000 requisiçõespor 1h429

Boas Práticas para Evitar Rate Limits#

1.
Implemente um sistema de retry (tentativa) com backoff: Ao receber um status code 429, aguarde antes de tentar novamente.
2.
Evite requisições desnecessárias: Certifique-se de que apenas as requisições essenciais sejam feitas.
3.
Aproveite a janela de isenção: Programe requisições em lote entre 0h e 5h, quando os limites de requisição por hora, DNS e IP não são aplicados, mas atente-se aos limites por requisições por segundo.
4.
Monitore suas requisições: Utilize logs para acompanhar e ajustar seu volume de chamadas à API.
Modified at 2026-05-15 03:49:27
Previous
Permissões do token
Next
API Pro
Built with