EVO API ES
Inicio
GuíasAPIs💎 API Pro📢 Novedades
Inicio
GuíasAPIs💎 API Pro📢 Novedades
  1. Inicio
  • ¡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. Inicio

Guias

Ponto de partida para usar a EVO API com eficiência#

Esta seção foi criada para oferecer suporte prático e contextual sobre como utilizar a EVO API de maneira eficaz.
Enquanto a Referência da API descreve endpoints, parâmetros e respostas, os guias focam em como aplicar esses recursos no mundo real — desde os primeiros passos até casos de uso completos.
Aqui você encontrará explicações, boas práticas, fluxos prontos e respostas para dúvidas frequentes.

🚀 Primeiros passos com a API#

Recursos essenciais para quem está começando a consumir a EVO API.
Começando a usar a EVO API
Entenda a estrutura geral da API, como autenticar requisições e como navegar pela documentação.
Permissões do token
Guia completo sobre escopos, permissões e boas práticas ao criar tokens para integrações.
Limites de requisições
Tudo sobre rate limits, limites de concorrência, uso responsável e como evitar bloqueios.
Chamadas de exportação para Excel
Como executar chamadas de exportação, boas práticas e como manipular o retorno.

🧭 Conhecendo a documentação#

Materiais para te ajudar a navegar melhor e aproveitar o máximo dos recursos da documentação.
Utilizar a documentação de forma eficaz
Explicação sobre como explorar endpoints, usar arquivos .txt para interagir com IA, copiar schemas, baixar especificações e trabalhar melhor com a documentação.

🛠️ Casos de uso#

Passo a passo de fluxos completos para implementar funcionalidades reais usando a EVO API.
Agendamento de aula experimental
Guia completo que demonstra o fluxo de marcação de uma aula teste, incluindo endpoints, parâmetros e validações.

❓ FAQ — Perguntas frequentes#

Reunimos problemas comuns, dúvidas recorrentes e orientações práticas organizadas por área do sistema. Ler mais.
Esses conteúdos serão expandidos ao longo do tempo conforme novas situações, dúvidas e integrações surgirem.
Modificado en 2026-05-15 03:33:02
Anterior
¡Bienvenido 💜
Siguiente
Primeros pasos con la EVO API
Built with