Qodex.ai

Joomla Web Services Collection For Postman

Number of APIs: 190

100+ Endpoints Joomla Web Services Collection For Qodex

An attempt to help the Joomla! 4.x/5.x/6.x early adopters mainly focused for developers. It's an unofficial Qodex collection of official Joomla Web Services Specification.

https://github.com/alexandreelise/j4x-api-collection for updates and information.

Or directly ready to use code in your favourite programming language generated by the documentation. Here is the link below

https://documenter.getQodex.com/view/7443864/2s9YywfKez

Presentation

Slides by Marc DECHÈVRE https://slides.woluweb.be/api/api.html

Installation

  • Click on the Run in Qodex button above or below in this README

  • Follow the instructions (You should fork the collection in your own Qodex workspace)

  • You should now have a new collection of endpoints in Qodex

  • Click on the collection, then on the ... on the right of the collection to open the settings for the collection

  • Set your own values for Authentication and Variables per the steps below

  • Test a generic GET request from the list to then confirm your authentication is working and your baseurl and basepath is set correctly.

Authentication

Authentication is done using a Joomla API Token. To get the token, go to your Super User profile in your Joomla 4 Installation and activate then copy the API key. In Qodex, edit the Collection and then click on the Authorization tab.

  • Select Type = API Key

  • For the Key field, enter X-Joomla-Token

  • In the Value field, paste your Joomla API Token

  • For the Add To field, leave the value as Header

  • Click Update to save the settings or click on Variables tab to modify your Base Path variable.

If you prefer a video about how to set up your Joomla API Token here is one:

Short video how to set up Joomla API Token

Full video is :

Joomla 4 tutorial: Using the Web Services API

URLs

The URLs are set via baseurl_ and basepath_. You should set this variable within your collection.

  • Click the 3 dots on the collection.

  • Select Edit.

  • Click on the variables tab.

  • Add (or update) the baseurl_ and basepath_ variable, setting the Initial Value field to the URL for your Joomla for installation.

Videos

YouTube playlist about Joomla Web Services / APIs

Setup

You might want to consider using :

https://github.com/muhme/joomla-branches-tester

Feedback

https://github.com/alexandreelise/j4x-api-collection for updates and information.

Documentation

The Qodex generated API documentation of Joomla! 4.x and above Web Services collection with directly ready to use code in your favourite programming language generated. Here is the link below

https://documenter.getQodex.com/view/7443864/2s9YywfKez

  1. 1. Banners-1.1 Banners - banners/{banner_id} GET {{base_url}}/{{base_path}}/banners/:banner_id

  2. 1. Banners-1.1 Banners - banners POST {{base_url}}/{{base_path}}/banners

  3. 1. Banners-1.1 Banners - banners GET {{base_url}}/{{base_path}}/banners

  4. 1. Banners-1.1 Banners - banners/{banner_id} PATCH {{base_url}}/{{base_path}}/banners/:banner_id

  5. 1. Banners-1.1 Banners - banners/{banner_id} DELETE {{base_url}}/{{base_path}}/banners/:banner_id

  6. 1. Banners-1.2 Banners Clients - banners/clients POST {{base_url}}/{{base_path}}/banners/clients

  7. 1. Banners-1.2 Banners Clients - banners/clients GET {{base_url}}/{{base_path}}/banners/clients

  8. 1. Banners-1.2 Banners Clients - banners/clients/{client_id} GET {{base_url}}/{{base_path}}/banners/clients/:client_id

  9. 1. Banners-1.2 Banners Clients - banners/clients/{client_id} PATCH {{base_url}}/{{base_path}}/banners/clients/:client_id

  10. 1. Banners-1.2 Banners Clients - banners/clients/{client_id} DELETE {{base_url}}/{{base_path}}/banners/clients/:client_id