Aperçu
Cette interface vous permet d'exécuter les fonctions de l'API cPanel de manière interactive.
Cette fonctionnalité utilise les données en direct de votre serveur. Les appels de fonction API peuvent modifier ou supprimer des données sur votre serveur, ce qui peut entraîner l'échec de votre serveur.
-
Lisez attentivement la documentation d'une fonction avant de l'utiliser dans l' interface API Shell , un script ou via toute autre méthode.
-
Pour voir un exemple de la sortie d'une fonction spécifique utilisant des données de test, lisez la section Exemple de cette fonction dans notre documentation développeur .
Activer l'interface API Shell
Pour utiliser cette fonctionnalité, votre hébergeur doit l'activer pour vous. Demandez-leur d'effectuer les étapes suivantes dans WHM:
-
Sélectionnez Activé pour le paramètre cPanel & WHM API shell (pour les développeurs) dans l' onglet Système de l' interface des paramètres de réglage de WHM ( WHM >> Accueil >> Configuration du serveur >> Paramètres de réglage ).
-
Accordez la fonctionnalité API Shell aux utilisateurs souhaités dans l' interface du gestionnaire de fonctionnalités de WHM ( WHM >> Accueil >> Packages >> Gestionnaire de fonctionnalités ).
Vous devez utiliser un compte revendeur pour accéder à l' interface API Shell .
Appeler une fonction API
Pour appeler une fonction API, procédez comme suit:
-
Sélectionnez l'API que vous souhaitez utiliser.
-
Sélectionnez la fonction API que vous souhaitez tester dans le menu.
-
Entrez les clés et les valeurs que vous souhaitez tester. Pour saisir plus de clés et de valeurs, cliquez sur Ajouter .
-
Pour filtrer, trier ou paginer les résultats, cliquez sur Afficher les options de tri / filtrage / pagination .
- Pour sélectionner le premier enregistrement à afficher à partir des résultats, entrez le numéro dans la zone de texte Index des premiers résultats à afficher, de base zéro ou utilisez le menu pour sélectionner le nombre.
- Pour limiter le nombre de résultats à afficher, entrez le nombre maximum de résultats dans la zone de texte Nombre maximum de résultats à afficher ou utilisez le menu pour sélectionner le nombre.
- Pour filtrer les résultats, cliquez sur Ajouter dans la section Filtres de l'interface.
- Vous pouvez spécifier le champ à utiliser pour filtrer les résultats, les conditions et le terme à appliquer aux conditions.
- Pour utiliser plusieurs filtres, cliquez sur Ajouter pour chaque filtre supplémentaire que vous souhaitez spécifier.
- Pour trier les résultats, cliquez sur Ajouter dans la section Trie de l'interface.
- Vous pouvez spécifier le champ par lequel vous souhaitez trier les résultats, les conditions et si vous souhaitez inverser l'ordre de tri.
- Pour utiliser plusieurs méthodes de tri, cliquez sur Ajouter pour chaque méthode de tri supplémentaire que vous souhaitez spécifier.
- Pour limiter les colonnes à afficher, cliquez sur Ajouter dans la section Colonnes de l'interface.
- Entrez le numéro de colonne dans la zone de texte Colonne .
- Pour spécifier plus de colonnes à afficher, cliquez sur Ajouter .
-
Cliquez sur Soumettre .
Retours d'appel API
Les retours apparaissent dans la section de réponse aux appels API de l'interface. Vous pouvez afficher les résultats en vue Tableau , en arborescence ou sous forme de réponse brute .