Overview

When businesses operate multiple web platforms, data inconsistencies become a recurring issue. In this use case, we helped a client synchronize data in real time between their Joomla site and a custom-developed platform using a custom API integration. The result: consistent, automated, and up-to-date data across both systems.

Prerequisites

This use case has been seamlessly implemented using the plugins listed below. To achieve this, you will need to install these plugins on your Joomla instance.

Custom API Extension for Joomla

The Custom API plugin allows you to create custom endpoints/REST routes to fetch/modify/create/delete data in Joomla.

Download Extension

The Challenge

The client had two independent systems:

• A website built on Joomla CMS.
• A custom-coded web application with no existing API.

They needed real-time, two-way data sync between the platforms. For instance, if a user signed up on the Joomla site, the user data needed to reflect immediately on the custom site, and vice versa. Manual syncing wasn’t scalable, and without an integration-ready API on the custom platform, real-time sync was technically blocked.

Our Solution

We developed a two-part solution:

• A custom PHP synchronization script that listens for Joomla events.
• A secure API on the custom website to receive and process data.

Whenever a user action, like a form submission, takes place on one site, the PHP script captures the data, formats it, and sends it to the other site using the API. The target site receives the request and performs the required operation (insert/update), ensuring both systems reflect the same data instantly.

How Joomla to Custom Site Flow Works

The authentication process was implemented in two distinct phases: token generation and token validation:

• A user submits a form on the Joomla site.
• Joomla triggers a system event (e.g., onContentAfterSave or a custom form event).
• The custom PHP script listens for this event and captures the submitted data.
• The script structures the data to match the custom API schema.
• It makes a secure API call (via cURL) to the endpoint on the custom site.
• The API receives and processes the request to update or insert data.

Note: The system is also configured for bidirectional sync using a similar approach on the custom platform.

Benefits

• Data Accuracy: Both platforms always reflect the latest user data.
• Automation: No more manual syncing or delayed updates.
• Real-Time Triggers: Immediate action can be taken based on user interactions.
• Future-Ready: Easily extendable for more data types and event triggers.

Result

By implementing this solution, the client now has:

• Consistent and reliable data across both websites.
• Automated data flow, removing any manual overhead.
• A synchronized user experience, where updates on one site reflect instantly on the other.

Additional Resources

1. Custom API Authentication for Joomla
2. Web3 Authentication for Joomla
3. Joomla Security Shield