Integration Overview
This page gives a high-level overview of an Ealyx custom integration before moving into the implementation details. It is intended to help both technical and non-technical stakeholders understand the integration scope, the main components involved, and the responsibilities expected from the merchant side.
If you are using a supported platform such as PrestaShop, Magento 2, or Shopify, see the Plugin Integration section instead.
What this integration covers
A custom integration connects your e-commerce platform directly to Ealyx, allowing trade-in functionality to be embedded into the shopper journey. Depending on the selected setup, this may include valuation flows, payment-related steps, session and order linking, and post-purchase updates.
What to expect from the integration
Integrating Ealyx typically involves both frontend and backend work. Merchants should expect to:
- integrate Ealyx touchpoints into the customer journey
- provide the required shopper, session, and order context
- enable communication between merchant systems and Ealyx services
- support the required callbacks or webhooks
- validate the integration in a test environment before going live
Main components involved
A typical integration involves the following components:
- Merchant storefront — where Ealyx touchpoints are presented to the shopper
- Merchant backend — which provides and processes shopper, session, and order data
- Ealyx services — which handle valuation, payment-related flows, and trade-in operations
- Shopper journey — where these systems connect across discovery, checkout, and post-purchase stages
Merchant responsibilities
Before going live, the merchant is expected to:
- implement the required integration points on the frontend and/or backend
- provide the data needed to connect shopper activity with session and order information
- support the required communication flows with Ealyx
- expose the required endpoints or webhook handlers
- complete testing and validation before launch
Choose your integration path
Ealyx supports two integration approaches depending on your stack and implementation needs.
| PHP SDK Integration Guide | API Integration Guide | |
|---|---|---|
| Best for | PHP-based platforms and custom PHP applications | Any language or framework |
| Approach | Use the Ealyx PHP SDK library | Direct HTTP/REST API calls |
| Setup | Composer package + SDK configuration | HTTP client + environment configuration |
| Auth handling | Managed by the SDK | Managed by the merchant |
When to use the PHP SDK
Choose this path if:
- your backend runs on PHP
- you want a faster and more guided implementation path
- you prefer higher-level abstractions such as SDK services, models, and automatic token handling
When to use the API directly
Choose this path if:
- your backend is not based on PHP
- you need full control over requests, responses, and integration logic
- you want a more flexible or fully custom implementation
Integration phases
Regardless of which path you choose, every custom integration follows the same four phases:
- Discovery — Display trade-in teasers across the site, such as on the homepage, product pages, cart, or checkout
- Valuation — The shopper values their device through the Ealyx flow
- Payment — Payment is handled through Ealyx Pay or alternative supported methods
- Post-Purchase — Order status and related events are synchronized with Ealyx
For a detailed explanation of each phase, see the Shopper Journey in the Introduction section.
Prerequisites
Before starting, make sure you have:
- Sandbox credentials — Contact your Ealyx account manager or email info@ealyx.com to request them
- HTTPS — Required for all environments, including staging and production
- Webhook endpoint — A publicly accessible URL where Ealyx can send notifications, if required by your integration flow
Ready to start?
Choose the guide that best fits your stack:
- PHP SDK Integration Guide — Step-by-step guidance using the Ealyx PHP SDK
- API Integration Guide — Complete guide using direct API calls from any language