Integrar landing page

Objetivo

Permitir que sistemas externos (sites, apps, totens ou CRMs) utilizem a EVO API para:

Exibir planos disponíveis (memberships) para compra

Exibir itens disponíveis para venda (produtos/serviços)

Criar e gerenciar um carrinho de compras (carts)

Direcionar o usuário para o checkout

Esse fluxo viabiliza a construção de jornadas completas de compra para prospects ou alunos, utilizando a EVO como backend comercial.

Endpoints Utilizados

Consultar planos disponíveis (memberships)

GET /api/v2/membership

Consultar itens disponíveis para venda (site/totem)

GET /api/v1/sales/sales-items

Criar carrinho

POST /api/v1/carts

Consultar carrinho

GET /api/v1/carts

Fluxo Técnico

1. Exibir Planos Disponíveis para Compra

O primeiro passo é consultar os planos disponíveis (memberships), que representam os produtos principais como planos mensais, anuais, etc.

Requisição:

GET /api/v2/membership?active=true&externalSaleAvailable=true

Parâmetros recomendados:

Parâmetro	Descrição
`active=true`	Retorna apenas planos ativos
`externalSaleAvailable=true`	Retorna planos disponíveis para venda externa
`idBranch`	Filtra planos por unidade
`showActivitiesGroups`	Retorna atividades vinculadas
`showOnlineSalesObservation`	Retorna observações de venda

Esses dados permitem exibir:

Nome do plano

Valor

Duração

Benefícios (diferenciais)

Regras comerciais

URL de venda (quando aplicável)

2. Exibir Itens Disponíveis para Venda

Além dos planos, é possível consultar diretamente os itens disponíveis para venda configurados no EVO (ex: planos + serviços adicionais).

Requisição:

GET /api/v1/sales/sales-items?idBranch=1

Esse endpoint retorna:

Itens exibidos na página de vendas

Informações de preço e parcelamento

Regras de pagamento (cartão, boleto, etc.)

Links de checkout

Configurações de fidelidade

Serviços adicionais (anuidade, taxas, etc.)

Importante:

Apenas itens com Autoatendimento habilitado são retornados.

3. Seleção de Itens pelo Usuário

Com base nas informações retornadas:

O usuário escolhe um plano (idMembership) ou serviço (idService)

Pode visualizar:

preço

parcelamento

benefícios

validade

Essa etapa ocorre no frontend (site/app/totem).

4. Criar Carrinho de Compra (Sales Intent)

Após a seleção dos itens, o sistema deve criar um carrinho para o usuário.

Requisição:

POST /api/v1/carts

Exemplo:

{
  "idBranch": 1,
  "idProspect": 123,
  "voucher": "PROMO10",
  "items": [
    {
      "idMembership": 2001
    }
  ]
}

Regras importantes:

Informar idMember (aluno) ou idProspect (lead)

Cada item deve conter:

idMembership ou

idService

Resposta:

{
  "idCartToken": "abc123",
  "cartCheckoutLink": "https://checkout.evo.com/xyz"
}

5. Redirecionar para Checkout

Com o cartCheckoutLink retornado:

O usuário pode ser redirecionado para finalização da compra

O checkout pode ocorrer:

em ambiente EVO

ou via integração customizada

6. Consultar Carrinho (Opcional)

Caso seja necessário recuperar ou validar o carrinho:

GET /api/v1/carts?idProspect=123

GET /api/v1/carts?idMember=1010

Permite:

recuperar itens selecionados

validar estado do carrinho

exibir resumo antes do pagamento

Cenário Adicional: Atualização de Planos

Para manter o catálogo atualizado:

GET /api/v2/membership?updateDate=2024-06-01

Esse filtro permite:

sincronizar apenas planos atualizados

reduzir volume de dados

manter consistência com o frontend

Perguntas Frequentes

1. Posso vender planos fora do EVO?

Sim, desde que o plano tenha externalSaleAvailable = true.

2. Qual a diferença entre membership e sales-items?

membership: representa o plano base (produto)

sales-items: representa o item configurado para venda (com regras comerciais, parcelamento, etc.)

3. Preciso usar carrinho obrigatoriamente?

Sim, o carrinho é o mecanismo oficial para iniciar o processo de compra e gerar o checkout.

4. Posso criar carrinho para prospect?

Sim. Utilize idProspect para leads ainda não convertidos.

5. O checkout pode ser customizado?

Sim, mas o fluxo padrão utiliza o cartCheckoutLink fornecido pela EVO.

Resultado Esperado

Após implementar esse fluxo:

Os planos e produtos estarão disponíveis para venda externa

O usuário poderá navegar, selecionar e comprar diretamente via integração

O processo de compra será estruturado (catálogo → carrinho → checkout)

A EVO será utilizada como backend central de vendas, garantindo consistência comercial

Integrar landing page

Objetivo#

Endpoints Utilizados#

Consultar planos disponíveis (memberships)#

Consultar itens disponíveis para venda (site/totem)#

Criar carrinho#

Consultar carrinho#

Fluxo Técnico#

1. Exibir Planos Disponíveis para Compra#

2. Exibir Itens Disponíveis para Venda#

3. Seleção de Itens pelo Usuário#

4. Criar Carrinho de Compra (Sales Intent)#

5. Redirecionar para Checkout#

6. Consultar Carrinho (Opcional)#

Cenário Adicional: Atualização de Planos#

Perguntas Frequentes#

1. Posso vender planos fora do EVO?#

2. Qual a diferença entre membership e sales-items?#

3. Preciso usar carrinho obrigatoriamente?#

4. Posso criar carrinho para prospect?#

5. O checkout pode ser customizado?#

Resultado Esperado#

Objetivo

Endpoints Utilizados

Consultar planos disponíveis (memberships)

Consultar itens disponíveis para venda (site/totem)

Criar carrinho

Consultar carrinho

Fluxo Técnico

1. Exibir Planos Disponíveis para Compra

2. Exibir Itens Disponíveis para Venda

3. Seleção de Itens pelo Usuário

4. Criar Carrinho de Compra (Sales Intent)

5. Redirecionar para Checkout

6. Consultar Carrinho (Opcional)

Cenário Adicional: Atualização de Planos

Perguntas Frequentes

1. Posso vender planos fora do EVO?

2. Qual a diferença entre membership e sales-items?

3. Preciso usar carrinho obrigatoriamente?

4. Posso criar carrinho para prospect?

5. O checkout pode ser customizado?

Resultado Esperado