Joomla Component Setup

This guide covers Joomla-specific aspects of API Mapper, including component access, cache integration, and platform-specific configuration.

Component Location

API Mapper installs as both a system plugin and a component in Joomla:

Access the Component:

• Navigate to Components → API Mapper in the Joomla administrator
• Or configure connections through the YOOtheme Customizer

Enable the Plugin:

1. Go to System → Manage → Plugins
2. Search for "API Mapper"
3. Ensure the plugin is enabled

Joomla Cache Integration

API Mapper integrates with Joomla's native caching system:

• Uses JCache for storing API responses
• Respects your global cache settings in System → Global Configuration → System
• Works with all cache handlers (File, Redis, Memcached)

Clearing the Cache

To clear API Mapper's cache:

1. Go to Components → API Mapper
2. Click Clear Cache in the toolbar

Or clear all Joomla cache:

• System → Clear Cache - removes expired cache
• System → Purge Expired Cache - removes all cache

Web Services API

When connecting to external Joomla 4/5 sites:

• Joomla's API endpoint is /api/index.php/v1/
• Authentication required: Unlike WordPress, Joomla needs API tokens
• Create tokens in Users → Manage → [User] → API Token

Access Control (ACL)

API Mapper respects Joomla's ACL system:

• Only users with appropriate permissions can manage connections
• Configure access in Components → API Mapper → Options → Permissions
• Default: Super Users and Administrators have full access

Multi-language Sites

For Joomla multilingual installations:

• API connections work across all languages
• Content filtering by language available via API parameters
• Use filter[language]=en-GB in your endpoint URL

Common Joomla Issues

Component Not Visible

• Verify the system plugin is enabled
• Check user permissions in component options
• Clear Joomla cache after installation

403 Forbidden on External APIs

• Joomla's Web Services require authentication
• Ensure Web Services plugins are enabled on the source site
• Verify the API user has correct viewing permissions

Next Steps

• First Connection - Create your first API connection
• Authentication - Configure Bearer tokens for Joomla APIs
• Caching - Optimize cache settings