Guide de configuration de l'extension d'API personnalisée Joomla

Marché

Le Extension API personnalisée Joomla vous permet de créer des API personnalisées pour étendre les fonctionnalités du CMS Joomla (système de gestion de contenu). Grâce à ces API, vous pouvez exposer des fonctionnalités ou des données particulières de votre site Web Joomla, permettant à des programmes ou services externes de communiquer avec votre site web Joomla. Grâce aux points de terminaison personnalisés que vous avez développés, ce plugin offre une méthode fluide pour travailler avec la base de données Joomla, vous permettant ainsi d'effectuer facilement des tâches. CRUD (Créer, Lire, Mettre à jour et Supprimer) fonctionnement sans maintenance

Télécharger le plugin Plans de tarification Essai gratuit

Étape 1 : Installation de l'extension API personnalisée

• Téléchargez le fichier zip pour le Extension d'API personnalisée miniOrange pour Joomla à partir du lien ci-dessus.
• Connectez-vous à votre site Joomla Administratrice console.
• Dans le menu bascule de gauche, cliquez sur Système, puis sous Installer section cliquez sur Extensions.

• Cliquez ici sur Rechercher un fichier bouton pour localiser et installer le fichier d'extension téléchargé précédemment.

• Une fois l'installation du plugin réussie. Cliquez maintenant sur Commencez à utiliser le plugin API personnalisé Joomla.

Étape 2 : créer des API personnalisées

• ÉCONOMISEZ
• POSTEZ [PRIME]
• PUT [PRIME]
• EFFACER [PRIME]

Pourquoi utiliser l'API GET

• Si vous souhaitez récupérer des données ou des informations de votre site Joomla, vous pouvez créer une API GET. Vous pouvez ajouter plusieurs filtres et conditions à cette API grâce à notre plugin.
• Lorsque vous envoyez une requête GET à une API, vous pouvez fournir des paramètres ou des chaînes de requête dans l'URL pour spécifier les données à récupérer sur votre site Joomla. Le plugin Joomla Custom API traite ensuite la requête et renvoie les données demandées dans la réponse.

Étapes de configuration pour la création d'une API GET personnalisée

• Naviguez d'abord vers le Créer une API personnalisée languette.
• Vous trouverez ici un outil prêt à l'emploi. API DE DÉMO qui récupère des données à partir de #__catégories tableau obtenu par une simple requête GET. Cliquez Test pour visualiser la réponse en direct instantanément.

• Maintenant, cliquez sur Créer une API personnalisée .

Configurer les détails de l'API

• Entrer le Nom de l'API et sélectionnez le Méthode GET du menu déroulant.
• Utilisation des paramètres
• Sélectionnez le type d’API : Par paramètres.
• Sélectionnez maintenant le nom de la table sur laquelle vous souhaitez effectuer l'action de récupération de données.
• Plusieurs options s'affichent désormais pour sélectionner les colonnes et les filtres de cette API. Veuillez préciser les colonnes de la table dont vous souhaitez extraire les données du site Joomla. Vous pouvez sélectionner plusieurs colonnes ici.
• [PRIME] Choisissez les conditions et filtres appropriés selon vos besoins, ou n'appliquez aucune condition. Cliquez sur le bouton + pour ajouter plusieurs conditions WHERE et filtrer les données. Vous pouvez supprimer une condition ou un filtre en cliquant sur le bouton -.
• [PRIME] Basculer sur le Activer l'authentification option permettant d'activer l'authentification sur le point de terminaison de l'API. (Consultez l’étape 3 pour savoir comment configurer l’authentification API.)
• Après avoir configuré l'API, cliquez sur Enregistrer bouton enfin pour créer votre point de terminaison personnalisé/API REST.

• Utilisation de l'API SQL personnalisée [PRIME]
• Sélectionnez le type d’API : API SQL personnalisée.
• Écrivez la requête SQL personnalisée à exécuter lors de l'appel d'API réussi. Par exemple :

SÉLECTIONNEZ * DANS #__utilisateurs OÙ id='{{id_param}}' ET email='{{email_param}}'; avoir _ est obligatoire dans le nom du paramètre.



• Cliquez sur le Enregistrer bouton pour créer l'API personnalisée.

Pourquoi utiliser l'API POST

• Si vous souhaitez envoyer des données à votre site Joomla pour créer des ressources sur le site, vous pouvez utiliser l'API POST.
• Lorsque vous envoyez une requête POST à ​​une API, vous envoyez des données dans le corps de la requête, généralement au format JSON ou codé par formulaire. Le plugin Joomla Custom API traite ensuite les données et exécute les actions nécessaires en fonction des informations fournies dans la requête.

Étapes de configuration pour la création d'une API POST personnalisée

• Naviguez d'abord vers le Créer une API/SQL personnalisée languette.
• Cliquez sur le Cliquez ici bouton pour créer une nouvelle API.

• Entrez un Nom de l'API et sélectionnez la méthode API POST dans le menu déroulant. Cliquez ensuite sur le bouton Créer une API .

Configurer les détails de l'API

• Utilisation des paramètres
• Sélectionnez le type d’API : Par paramètres.
• Sélectionnez maintenant le nom de la table sur laquelle vous souhaitez effectuer l’action de création de données.
• Plusieurs options de sélection de colonnes s'afficheront désormais. Veuillez préciser les colonnes de la table dont vous souhaitez extraire les données du site Joomla. Vous pouvez sélectionner plusieurs colonnes ici.
• Sélectionnez le Format des données corporelles dans lequel vous souhaitez envoyer les données à l'en-tête à partir de la liste déroulante.
• Basculer sur le Activer l'authentification option si vous souhaitez activer l'authentification sur le point de terminaison de l'API. (Consultez l’étape 3 pour savoir comment configurer l’authentification API.)
• Après avoir configuré l'API, cliquez sur Enregistrer bouton enfin pour créer votre point de terminaison personnalisé/API REST.

• Utilisation de l'API SQL personnalisée
• Sélectionnez le type d’API : API SQL personnalisée.
• Vous pouvez rendre tous les paramètres obligatoires en cochant la case correspondante. Cette fonctionnalité nécessite que tous les paramètres client soient transmis lors d'un appel d'API.
• Écrivez la requête SQL personnalisée à exécuter lors de l'appel d'API réussi. Par exemple :

INSÉRER DANS #__utilisateurs (id, nom, nom d'utilisateur, email, registerDate, params) VALEURS '{{id}}','{{name}}','{{username}}','{{email}}','{{registerDate}}','{{params}}';



• Cliquez sur le Enregistrer bouton pour créer l'API personnalisée.

Pourquoi utiliser l'API PUT

• Si vous souhaitez mettre à jour ou remplacer une ressource existante sur votre site Joomla, vous pouvez créer une API PUT.
• Lorsque vous effectuez une requête PUT vers une API, vous envoyez des données dans des paramètres, des chaînes de requête ou dans le corps de la requête pour remplacer la représentation complète de la ressource identifiée par l'URL de la requête. Le plugin Joomla Custom API traite ensuite les données et met à jour la ressource en conséquence.

Étapes de configuration pour la création d'une API PUT personnalisée

• Naviguez d'abord vers le Créer une API/SQL personnalisée languette.
• Cliquez sur le Cliquez ici bouton pour créer une nouvelle API.

• Entrez un Nom de l'API et sélectionnez la méthode API PUT dans le menu déroulant. Cliquez ensuite sur le Créer une API .

Configurer les détails de l'API

• Utilisation des paramètres
• Sélectionnez le type d’API : Par paramètres.
• Sélectionnez maintenant le nom de la table sur laquelle vous souhaitez saisir de nouvelles données.
• Sélectionnez ensuite les colonnes pour lesquelles vous souhaitez mettre à jour à l'aide de l'appel API.
• Choisissez les conditions appropriées selon vos besoins ou n'en choisissez aucune. Cliquez sur le bouton + pour ajouter plusieurs conditions WHERE afin de filtrer les données. Vous pouvez également supprimer la condition en cliquant sur le bouton -.
• Vous avez la possibilité de transmettre les données soit sous forme de paramètres de requête, soit dans le corps de la requête.
• Assurez-vous de transmettre les données en utilisant le format clé = Nom du paramètre (mentionné dans le tableau Format de la demande et conditions appliquées) et valeur = conformément aux exigences spécifiques.
• Pour mettre à jour l'entrée utilisateur de l'exemple ci-dessus, vous devez suivre ce qui suit :
• Saisissez l'URL : '{joomla_base_url}/api/index.php/v1/mini/custom_put'.
• Sélectionnez ensuite la méthode HTTP PUT.
• Transmettez les données pour le nom, le nom d'utilisateur, param_1, param_2 dans le corps de la requête (vous pouvez également transmettre le format de requête).
• Vous recevrez 1 dans la réponse si les données ont été mises à jour avec succès dans le tableau.

• Utilisation de l'API SQL personnalisée
• Sélectionnez le type d’API : API SQL personnalisée.
• Écrivez la requête SQL personnalisée à exécuter lors de l'appel d'API réussi. Par exemple :

MISE À JOUR #__users set username='{{username}}' où id='{{id}}';



• Cliquez sur le Enregistrer bouton pour créer l'API personnalisée.

Pourquoi utiliser l'API DELETE

• Si vous souhaitez supprimer une ressource spécifique sur votre site Joomla, vous pouvez créer une API DELETE.
• Lorsque vous effectuez une requête DELETE auprès d'une API, vous pouvez fournir des paramètres ou des chaînes de requête dans l'URL ou dans le corps de la requête pour spécifier les données à supprimer de votre site Joomla. Le plugin Joomla Custom API traite ensuite les données et met à jour la ressource en conséquence.

Étapes de configuration pour la création d'une API DELETE personnalisée

• Naviguez d'abord vers le Créer une API/SQL personnalisée languette.
• Cliquez sur le Cliquez ici bouton pour créer une nouvelle API.

• Entrez un Nom de l'API et sélectionnez la méthode API SUPPRIMER dans le menu déroulant. Cliquez ensuite sur le Créer une API .

Configurer les détails de l'API

• Utilisation des paramètres
• Sélectionnez le type d’API : Par paramètres.
• Sélectionnez maintenant le nom de la table sur laquelle vous souhaitez effectuer l’action de suppression des données.
• Choisissez les conditions appropriées selon vos besoins ou n'en choisissez aucune. Cliquez sur le bouton + pour ajouter plusieurs conditions WHERE afin de filtrer les données. Vous pouvez également supprimer la condition en cliquant sur le bouton -.
• Basculer sur le Activer l'authentification option si vous souhaitez activer l'authentification sur le point de terminaison de l'API. (Consultez l’étape 3 pour savoir comment configurer l’authentification API.)
• Après avoir configuré l'API, cliquez sur Enregistrer bouton enfin pour créer votre point de terminaison personnalisé/API REST.

• Utilisation de l'API SQL personnalisée
• Sélectionnez le type d’API : API SQL personnalisée.
• Écrivez la requête SQL personnalisée à exécuter lors de l'appel d'API réussi. Par exemple :

DELETE FROM #__users WHERE id='{{id}}';



• Cliquez sur le Enregistrer bouton pour créer l'API personnalisée.

Étape 3 : Configurer l’authentification API [PRIME]

• Jeton porteur
• Authentification JWT
• L'authentification de base
• clé API

Authentification du jeton du porteur :

Une authentification simple basée sur un jeton où les clients envoient un jeton Bearer dans l'en-tête d'autorisation.

• Tout d'abord, activez le Activer l'authentification bouton dans le Configurer les détails de l'API .
• Dans l' Configurer l'authentification menu, sélectionnez Jeton porteur dans le menu déroulant.
• Cliquez sur le Générer un jeton Bouton pour créer automatiquement un jeton aléatoire sécurisé. Par exemple : 7c4a8d09ca3762af61e59520943dc26494f8941b
• Cliquez sur « Enregistrer la configuration » pour appliquer les paramètres du jeton porteur. Le jeton sera stocké en toute sécurité dans la base de données.

Utilisation de l'API :

• Inclure le jeton dans les requêtes API :

Header: Authorization: Bearer 7c4a8d09ca3762af61e59520943dc26494f8941b



• Testez le jeton du porteur à l’aide des commandes cURL suivantes :

```bash
curl -X GET "https://votresite.com/api/endpoint" \
-H "Autorisation : Porteur votre_jeton_ici" \
-H "Type de contenu : application/json"

Tester l'authentification à l'aide de Postman :

• Ouvrez Facteur.
• Définissez la méthode de demande et l'URL.
• Maintenant, allez dans l’onglet Autorisation.
• Sélectionnez le type « Jeton porteur ».
• Ensuite, entrez votre jeton dans le champ Jeton.

Authentification de base (Joomla User Auth) :

Utilise les informations d'identification de l'utilisateur Joomla existantes (nom d'utilisateur/mot de passe) codées en Base64 et envoyées via l'en-tête d'autorisation.

• Tout d'abord, activez le Activer l'authentification bouton dans le Configurer les détails de l'API .
• Dans l' Configurer l'authentification menu, sélectionnez Authentification de base dans le menu déroulant.
• Aucune configuration supplémentaire n'est requise, mais les utilisateurs doivent exister dans la base de données des utilisateurs Joomla.
• Enfin, cliquez sur le Enregistrer la configuration .

Utilisation de l'API :

• Inclure le nom d'utilisateur/mot de passe Joomla dans les requêtes API :

En-tête : Autorisation : Base64 de base (nom d'utilisateur : mot de passe)



• Testez l'authentification de base à l'aide des commandes cURL suivantes :

```bash curl -X GET "https://votresite.com/api/endpoint" \
-H "Autorisation : Basic $(echo -n 'user:pass' | base64)" \
-H "Type de contenu : application/json"

Tester l'authentification à l'aide de Postman :

• Ouvrez Facteur.
• Définissez la méthode de demande et l'URL.
• Maintenant, allez dans l’onglet Autorisation.
• Sélectionnez le type « Authentification de base ».
• Entrez le nom d'utilisateur et le mot de passe Joomla.

Authentification par clé API (authentification utilisateur Joomla) :

Authentification par en-tête utilisant des clés API. Prend en charge les clés universelles (une clé unique pour tous les utilisateurs) et les clés utilisateur (clés individuelles par utilisateur).

• Tout d'abord, activez le Activer l'authentification bouton dans le Configurer les détails de l'API .
• Dans l' Configurer l'authentification menu, sélectionnez clé API dans le menu déroulant.
• Maintenant, choisissez le Type de clé API.
• Pour la clé API universelle :
• Sélectionner Clé API universelle bouton radio.
• Cliquez sur Générer une clé API universelle .
• Une clé API unique sera générée pour tous les accès API. Par exemple : uk_7c4a8d09ca3762af61e59520943dc26494f8941b
• Pour la clé API basée sur l’utilisateur :
• Sélectionner Clé API basée sur l'utilisateur bouton radio.
• Générer des clés pour tous les utilisateurs Joomla existants : Cliquez à nouveau Générer des clés API pour tous les utilisateurs. Des clés seront créées pour tous les utilisateurs actifs de Joomla.
• Générer une clé pour un utilisateur spécifique : Saisissez votre nom d'utilisateur dans le champ « Nom d'utilisateur ». Cliquez sur Générer une clé API pour l'utilisateur.
• Cliquez à nouveau Enregistrer la configuration pour appliquer les paramètres de clé API.

Utilisation de l'API :

• Inclure la clé API dans les requêtes :

En-tête : X-API-KEY :



• Testez la clé API à l’aide des commandes cURL suivantes :

```bash
curl -X GET "https://votresite.com/api/endpoint" \
-H "X-API-KEY: votre_clé_api_ici" \
-H "Type de contenu : application/json"

Tester l'authentification à l'aide de Postman :

• Ouvrez Facteur.
• Définissez la méthode de demande et l'URL.
• Maintenant, allez dans l’onglet En-têtes.
• Ajouter un en-tête : Clé = « X-API-KEY », Valeur = « your_api_key ».

Authentification JWT :

L'authentification JWT vous permet d'authentifier l'accès aux points de terminaison de l'API REST personnalisée et de l'API par défaut de Joomla à l'aide d'un jeton JWT valide (jeton Web JSON). Le plugin fournit un point de terminaison pour générer un JWT Bearer à l'aide des identifiants de connexion Joomla valides de l'utilisateur. Le jeton généré peut être utilisé pour authentifier les points de terminaison de l'API REST personnalisée et de l'API REST Joomla.

• Tout d'abord, activez le Activer l'authentification bouton dans le Configurer les détails de l'API .
• Dans l' Configurer l'authentification menu, sélectionnez Porteur JWT dans le menu déroulant.
• Maintenant, choisissez le Type de clé API.
• Sélectionnez le Algorithme de signature Dans le menu déroulant.
• Pour HS256, entrer le Clef secrète.
• Pour RS256, téléchargez le Clés publiques et privées.
• Saisissez l'heure d'expiration (par exemple 3600 pour 1 heure).
• Cliquez sur le Enregistrer .

Pour obtenir le jeton JWT, suivez les étapes suivantes :

• Pour obtenir le JWT, nous devons soumettre une requête POST contenant les identifiants Joomla de l'utilisateur. Le nom d'utilisateur et le mot de passe doivent être codés en base64. Pour plus de commodité, veuillez vous référer au format de la requête ci-dessous.

Requête : POST {joomla_base_url}/api/index.php/v1/mini/id_token
Entête:
Autorisation : Base64 codée de base
Accepter: application / json
Exemple de format de demande de boucle-
--emplacement --request POST "/api/index.php/v1/mini/id_token' \"
--header 'Accepter : application/json'\
--header 'Type de contenu : application/json' \
--header 'Autorisation : encodage en base64 de base' \'

Étape 4 : Authentification pour les API REST [PRIME]

Configurez l'authentification pour les API principales de Joomla et les API hébergées sur votre site Joomla qui seront automatiquement appliquées lorsque ces API sont appelées.

• Rendez-vous dans la section Authentification API REST languette.
• Entrer le Nom de l'API et Point de terminaison de l'API dans les champs donnés.
• Ensuite, sélectionnez le Méthode HTTP Dans le menu déroulant.
• Ensuite, activez le Activer l'authentification et sélectionnez la méthode d'authentification de votre choix. Reportez-vous à la Étape 3 section du guide pour voir comment configurer les différentes méthodes d'authentification.

Étape 5 : Configurer les API externes [PRIME]

• Rendez-vous dans la section API externes languette.
• Entrez le nom de l'API.
• Ensuite, sélectionnez le Méthode API de la liste déroulante.
• Entrer le API externe dans le domaine donné.
• Vous pouvez transmettre les paramètres de requête nécessaires à cette API configurée, afin que les données soient envoyées au format des paramètres de requête.
• Il y a 2 champs de texte : le premier consiste à saisir la clé et le second à saisir la valeur.
• Par exemple → Si vous devez passer le paramètre de requête suivant « username→testuser », vous devez alors mettre « username » dans la clé et « testuser » dans le champ valuE.
• Vous pouvez ajouter plusieurs paramètres en utilisant le bouton +.
• Dans les en-têtes, il y a deux zones de texte : celle de gauche pour le nom de l'en-tête et celle de droite pour la valeur à transmettre. Par exemple : si l'en-tête transmis est au format « Autorisation : Porteur », « Autorisation » sera ajouté dans la première zone de texte et « Porteur » dans la zone de texte de droite, comme illustré ci-dessous.
• Si le fournisseur d'API souhaite que les données soient envoyées dans le corps de la requête des points de terminaison de l'API, vous pouvez renseigner les informations requises. Deux formats d'envoi sont disponibles : x-www-form-urlencoded et JSON.
• Pour que les données soient envoyées dans les paramètres du corps au format x-www-form-urlencoded.
• Il y a 2 champs de texte : le premier consiste à saisir la clé et le second à saisir la valeur.
• Par exemple → Si vous devez passer le paramètre de corps suivant « username→testuser », vous devez alors mettre « username » dans la clé et « testuser » dans le champ de valeur.
• Pour les paires clé-valeur multiples qui doivent être transmises dans le corps de la demande de point de terminaison de l'API, vous pouvez cliquer sur le bouton +.
• Pour que les données soient envoyées dans les paramètres du corps au format JSON : Vous devez sélectionner le JSON dans la liste déroulante correspondant au corps de la requête
• Maintenant, cliquez sur le Enregistrer la configuration .

Étape 6 : Configurer les API REST de Joomla Core [PRIME]

• Accédez à la API REST principales de Joomla onglet et cliquez sur le Configurer une nouvelle API .

• Pour configurer l'API REST de Joomla Core, vous aurez besoin d'un jeton d'authentification API. Rendez-vous sur Utilisateurs -> Gérer -> Cliquez sur un utilisateur.

• Allez ici au Jeton d'API Joomla et copiez le jeton.

• Retour à la API REST principale de Joomla Appuyez sur l'onglet et collez le jeton généré dans le champ prévu à cet effet. Saisissez un nom pour cette configuration, puis choisissez l'option requise. Endpoint à partir du menu déroulant. Si nécessaire, vous pouvez également appliquer Filtres de requête et configurer le Champs de point de terminaison ainsi que le préféré Format de sortieUne fois que tout est prêt, cliquez sur API de test bouton pour vérifier la configuration.

• Vous verrez un Réponse de l'API Si la configuration a réussi, cliquez ensuite sur Enregistrer la configuration .

• Votre API REST principale de Joomla La configuration a été effectuée avec succès. Vous pouvez maintenant copier le fichier généré. petit code Vous pouvez copier le code de cette section et le placer n'importe où sur votre site pour afficher directement la réponse de l'API côté client.

Articles Relatifs

• En savoir plus sur notre extension API personnalisée.
• Synchronisation des données en temps réel entre Joomla et un site Web personnalisé.
• Implémentation de l'authentification JWT sécurisée pour les API Joomla Core.