Créer des points de terminaison d'API REST externes dans Dotnetnuke (DNN)
Marché
Le plugin API REST DNN permet une intégration fluide des API externes aux sites DNN, ce qui permet d'effectuer des opérations de récupération et de mise à jour sur des données externes via des appels API. Ce plugin permet de récupérer ou de mettre à jour des données externes lors de divers événements ou opérations DNN, tels que la connexion ou l'enregistrement d'un utilisateur, etc. Ce guide vous fournira un processus étape par étape pour configurer l'API REST externe pour les sites DNN.
Pré-requis : téléchargement et installation
- Pour configurer les API externes pour l'API REST DNN, vous devrez installer le Plugin d'authentification API REST DNN miniOrange de la boutique DNN.
- Téléchargez le package d'installation en allant sur Paramètres > Extension > Installer l'extension.
Étapes de configuration
Guide étape par étape pour l’authentification API externe DNN.
1. Ajouter un module sur la page DNN
- Ouvrez n'importe quelle page de votre site DNN (mode édition) et cliquez sur Ajouter un module.
- Recherchez API REST DNN et cliquez sur l'API REST DNN. Faites glisser et déposez le module sur la page où vous le souhaitez.
- Vous avez terminé l'installation du module API REST DNN sur votre site DNN.
2. Créer des API externes
- Accédez à la Paramètres de l'API REST DNN Tab. Ici, vous verrez le Tableau de bord du plug-in DNN REST API.
- Cliquez sur Créer une API, pour lancer la génération d'API externes.
- Maintenant, sélectionnez API externe.
- Entrez les détails suivants:
- Nom de l'API : Donnez un nom unique à votre API.
- Méthode API : Sélectionner Méthode de requête HTTP de la liste déroulante.
- Point de terminaison de l'API externe : Configurez votre point de terminaison d’API externe.
- Vous pouvez configurer la méthode d’authentification pour l’API à partir de l’onglet Autorisation et ajouter des en-têtes si nécessaire à partir de l’onglet En-têtes.
- Vous pouvez également transmettre les données du corps dans différents formats, notamment JSON, x-www-form-urlencoded, xml, etc. à partir de l'onglet Corps.
- Dans la section des paramètres avancés, vous avez la possibilité de transmettre les paramètres.
- Après avoir entré les détails, cliquez sur Générer une API.
- Maintenant, sous la section API externes, vous pouvez trouver votre API générée.
3. Testez les API externes
- Pour tester l'API, cliquez sur le Test option sous la Action menu déroulant.
- Une fenêtre de test apparaîtra. Fournissez les détails requis tels que les en-têtes ou les données du corps, puis cliquez sur Exécution .
- Si tout est configuré correctement, une réponse de réussite sera renvoyée par l'API confirmant que votre API externe est correctement configurée.
Ce guide vous permettra de configurer et d'intégrer vos API externes dans votre application DNN. En utilisant cette intégration d'API REST avec DNN, vous pouvez effectuer en toute sécurité des opérations de récupération, d'insertion, de mise à jour et de suppression sur les données externes via des appels d'API depuis votre application DNN.
