Integrate landing page

Objective

Allow external systems (websites, apps, kiosks, or CRMs) to use the EVO API to:

Display available plans (memberships) for purchase

Display items available for sale (products/services)

Create and manage a shopping cart (carts)

Direct the user to checkout

This flow enables the construction of complete purchasing journeys for prospects or members, using EVO as the commercial backend.

Used Endpoints

Consult Available Plans (memberships)

GET /api/v2/membership

Consult Items Available for Sale (website/kiosk)

GET /api/v1/sales/sales-items

Create Cart

POST /api/v1/carts

Consult Cart

GET /api/v1/carts

Technical Flow

1. Display Available Plans for Purchase

The first step is to consult the available plans (memberships), which represent the main products such as monthly, annual plans, etc.

Request:

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

Recommended parameters:

Parameter	Description
`active=true`	Returns only active plans
`externalSaleAvailable=true`	Returns plans available for external sale
`idBranch`	Filters plans by branch
`showActivitiesGroups`	Returns linked activities
`showOnlineSalesObservation`	Returns sales observations

This data allows displaying:

Plan name

Price

Duration

Benefits (differentials)

Commercial rules

Sales URL (when applicable)

2. Display Items Available for Sale

In addition to plans, it is possible to directly consult the items available for sale configured in EVO (e.g., plans + additional services).

Request:

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

This endpoint returns:

Items displayed on the sales page

Price and installment information

Payment rules (credit card, boleto, etc.)

Checkout links

Loyalty settings

Additional services (annual fees, charges, etc.)

Important:

Only items with Self-service enabled are returned.

3. User Selection of Items

Based on the returned information:

The user selects a plan (idMembership) or service (idService)

Can view:

price

installment options

benefits

validity

This step occurs on the frontend (website/app/kiosk).

4. Create Shopping Cart (Sales Intent)

After selecting the items, the system must create a cart for the user.

Request:

POST /api/v1/carts

Example:

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

Important rules:

Provide idMember (member) or idProspect (lead)

Each item must contain:

idMembership or

idService

Response:

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

5. Redirect to Checkout

With the returned cartCheckoutLink:

The user can be redirected to complete the purchase

The checkout can occur:

in the EVO environment

or via custom integration

6. Consult Cart (Optional)

If it is necessary to retrieve or validate the cart:

GET /api/v1/carts?idProspect=123

GET /api/v1/carts?idMember=1010

Allows:

retrieve selected items

validate cart status

display summary before payment

Additional Scenario: Update Plans

To keep the catalog updated:

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

This filter allows:

synchronize only updated plans

reduce data volume

maintain consistency with the frontend

Frequently Asked Questions

1. Can I sell plans outside of EVO?

Yes, as long as the plan has externalSaleAvailable = true.

2. What is the difference between membership and sales-items?

membership: represents the base plan (product)

sales-items: represents the item configured for sale (with commercial rules, installment options, etc.)

3. Do I have to use a cart?

Yes, the cart is the official mechanism to initiate the purchase process and generate the checkout.

4. Can I create a cart for a prospect?

Yes. Use idProspect for leads that have not yet converted.

5. Can the checkout be customized?

Yes, but the standard flow uses the cartCheckoutLink provided by EVO.

Expected Outcome

After implementing this flow:

Plans and products will be available for external sale

The user will be able to browse, select, and purchase directly via integration

The purchasing process will be structured (catalog → cart → checkout)

EVO will be used as the central sales backend, ensuring commercial consistency

Integrate landing page

Objective#

Used Endpoints#

Consult Available Plans (memberships)#

Consult Items Available for Sale (website/kiosk)#

Create Cart#

Consult Cart#

Technical Flow#

1. Display Available Plans for Purchase#

2. Display Items Available for Sale#

3. User Selection of Items#

4. Create Shopping Cart (Sales Intent)#

5. Redirect to Checkout#

6. Consult Cart (Optional)#

Additional Scenario: Update Plans#

Frequently Asked Questions#

1. Can I sell plans outside of EVO?#

2. What is the difference between membership and sales-items?#

3. Do I have to use a cart?#

4. Can I create a cart for a prospect?#

5. Can the checkout be customized?#

Expected Outcome#

Objective

Used Endpoints

Consult Available Plans (memberships)

Consult Items Available for Sale (website/kiosk)

Create Cart

Consult Cart

Technical Flow

1. Display Available Plans for Purchase

2. Display Items Available for Sale

3. User Selection of Items

4. Create Shopping Cart (Sales Intent)

5. Redirect to Checkout

6. Consult Cart (Optional)

Additional Scenario: Update Plans

Frequently Asked Questions

1. Can I sell plans outside of EVO?

2. What is the difference between membership and sales-items?

3. Do I have to use a cart?

4. Can I create a cart for a prospect?

5. Can the checkout be customized?

Expected Outcome