Skip to main content

Installation

This guide helps you set up the Joomla Webservices API.

Requirements​

Before you begin, make sure you have the following:

  • Joomla 5.x or higher
  • PHP 8.2 or higher
  • MySQL 8.0.36 or higher
  • A development environment

Step 1: Activate Joomla Webservices Plugin​

  1. Log in to your Joomla administration panel
  2. Go to System → Plugins
  3. Search for "Webservices"
  4. Activate the following plugins:
    • Webservices - Authentication
    • Webservices - Content
    • Webservices - Users

Step 2: Create API Token​

  1. Go to Users → Manage
  2. Select a user or create a new one
  3. Go to the "API Token" tab
  4. Click on "Create API Token"
  5. Copy the generated token (you won't be able to see it later!)

Step 3: Test the connection​

Test if the API works with a simple request:

curl -X GET "https://yoursite.com/api/index.php/v1/content/articles" \
  -H "X-Joomla-Token: YOUR_API_TOKEN"

If everything is set up correctly, you will receive a JSON response with articles.

Next steps​

Continue with Authentication to learn more about the different authentication methods.