Créer des points de terminaison d'API REST personnalisés dans Dotnetnuke (DNN)

Marché

Le plugin API REST DNN permet de créer des points de terminaison d'API personnalisés au sein de la plateforme DNN, permettant ainsi aux systèmes externes d'interagir avec les fonctionnalités DNN. Vous pouvez facilement configurer vos points de terminaison d'API personnalisés pour répondre à des exigences spécifiques, en utilisant toutes les méthodes HTTP. Ce guide d'utilisation propose une documentation complète pour vous aider à configurer et à tester des API personnalisées.

Pré-requis : téléchargement et installation

• Pour configurer les API personnalisées 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 personnalisée 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 personnalisées

• Accédez à la Onglet Paramètres de l'API REST DNN. Ici, vous verrez le Tableau de bord du plugin d'authentification DNN REST API.

• Cliquez sur Créer une API, pour lancer la génération d'API personnalisées.

• Sélectionnez le type d'API comme API personnalisée.

• Entrez les détails suivants:

1. Nom de l'API : Donnez un nom unique à votre API.
2. Méthode API : Sélectionner Méthode de requête HTTP de la liste déroulante.
3. Nom de la table: Spécifiez la table à laquelle vous souhaitez accéder.
4. Colonne de réponse : Sélectionnez les colonnes sur lesquelles vous souhaitez effectuer des opérations.
5. Configurer l’authentification (facultatif) : Dans l'onglet Paramètres avancés, vous pouvez trouver une option permettant de sélectionner les méthodes d'authentification pour l'API, qui incluent la clé API, l'authentification de base, le JWT, etc., et de mapper l'application d'authentification créée pour la méthode respective.
6. Appliquer des filtres (facultatif) : Vous pouvez appliquer des conditions sur les colonnes qui vous permettent d'accéder à des enregistrements particuliers en fonction des filtres appliqués.
   Pour le configurer, vous pouvez sélectionner la colonne dans la liste déroulante de la colonne Condition, puis choisir la condition et le paramètre d'URL sur lesquels vous souhaitez appliquer la condition.

• Cliquez sur Générer une API.

• Maintenant sous la API personnalisées section, vous pouvez localiser votre API créée.

3. Testez les API générées

• Pour tester l'API, cliquez sur le Test option sous la Action menu déroulant.

• Une fenêtre contextuelle de test apparaîtra contenant votre point de terminaison API avec la méthode HTTP configurée. Vous pouvez trouver l'option permettant de transmettre les paramètres dans les en-têtes ou de transmettre les données dans le corps si nécessaire. Cliquez ensuite sur Exécuter.

• Si tout est configuré correctement, vous verrez une réponse réussie, confirmant que votre API fonctionne comme prévu.

• Vous pouvez consulter les exemples de formats de demande et de réponse pour votre demande d'API à partir de la fenêtre contextuelle de test.

Ce guide vous permettra de configurer et de créer des API REST personnalisées pour votre site DNN. Grâce au plugin API REST de DNN, vous pourrez configurer, tester et gérer vos API REST DNN en toute sécurité.

Articals connexes

• Qu’est-ce que l’authentification API REST ?
• Connexion unique SAML DNN
• SSO OAuth de DNN
• Authentification à deux facteurs DNN (2FA)
• Intégration DNN PowerBI