Giter VIP home page Giter VIP logo

noxidsoft / j4x-api-collection Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alexandreelise/j4x-api-collection

0.0 0.0 0.0 539 KB

An attempt to help the Joomla! 4 early adopters mainly focused for developers. It's an unofficial postman collection of the official since Joomla4 Beta API until now

Home Page: https://manual.joomla.org/docs/general-concepts/webservices

License: GNU General Public License v2.0

j4x-api-collection's Introduction

100+ Endpoints Joomla Web Services Collection For Postman

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

Run in Postman

Installation

  • Click on the Run in Postman button above or below in this README
  • Follow the instructions (You should fork the collection in your own postman workspace)
  • You should now have a new collection of endpoints in Postman
  • 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 base_url and base_path 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 Postman, 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.

URLs

The URLs are set via base_url and base_path. 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 base_url and base_path variable, setting the Initial Value field to the URL for your Joomla for installation.

Documentation

The Postman generated Api documentation of Joomla! 4 Webservices collection

Run in Postman

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.