Welcome to Zūm Rails Aggregation Documentation!
This documentation provides both a high-level view of the process as well as the steps to successfully use the aggregation services.
There are two main different ways of using Zūm Rails Aggregation service:
- Full API Integration
- Connector UI
This integration method allows your own application to take full control of the experience. It's recommended only for partners. In order to have access to it, please drop us a message at firstname.lastname@example.org or using the chat inside our portal. We will review case by case to enable this option.
Connector UI is the recommended way of integrating with Zum Rails Aggregation for most of our clients. For this integration method, we provide you a complete component for you to embed inside your existing application.
The Connector UI it's the easiest way to use. It's a unique URL you can host as an iframe, send by e-mail or sms.
The first step to build your aggregation integration is to configure your experience.
If you are using other products from Zūm Rails, such us the Payments or Invoice and Subscription, the Zūm Rails UI will automatically use Zūm Rails Data Aggregation. This session is only usefull if you are using only Zūm Rails Data Aggregation services