Le module registraire WHC vous permet de gérer vos domaines WHC directement depuis votre propre installation WHMCS. Une fois installé et connecté, vous pouvez vérifier la disponibilité, enregistrer, renouveler et transférer des domaines, gérer les verrous de registraire, récupérer les codes EPP, et mettre à jour les serveurs de noms et les coordonnées, le tout depuis votre console d'administration WHMCS.
Cet article explique comment télécharger, installer et configurer le module. Il aborde aussi trois points à comprendre avant de commencer : la version de WHMCS requise, l'étiquette API appliquée aux domaines enregistrés par l'API, et le comportement par défaut du renouvellement automatique.
Avant de commencer
Vous aurez besoin des éléments suivants :
Un compte WHC actif.
L'API activée sur votre compte. Dans votre Espace client, ouvrez la section API, lisez et acceptez les conditions d'utilisation de l'API, puis activez l'API. Vous ne pouvez pas télécharger ni utiliser le module tant que l'API n'est pas activée.
Vos identifiants d'API (identifiant client et clé API), disponibles dans la section API de votre Espace client une fois l'API activée.
Une installation WHMCS qui répond à l'exigence de version ci-dessous.
Version de WHMCS requise
Le module prend en charge WHMCS 8.0 et versions ultérieures. Les versions antérieures ne sont pas prises en charge. Si vous utilisez une version plus ancienne, mettez WHMCS à jour avant d'installer le module.
Pour vérifier votre version, connectez-vous à votre console d'administration WHMCS. Votre version actuelle est indiquée sous Informations système (System Information).
Télécharger le module
Connectez-vous à votre Espace client WHC.
Ouvrez la section API depuis le menu principal.
Dans le tableau de bord API, sélectionnez Télécharger le module WHMCS.
Enregistrez le fichier .zip sur votre ordinateur.
Le téléchargement est un module registraire WHMCS standard. Le même fichier est utilisé par tous les clients. Il ne contient pas vos identifiants d'API. Vous les saisissez lors de la configuration.
Installer le module
Décompressez le fichier téléchargé. Vous verrez un seul dossier de module (par exemple,
whc).Téléversez ce dossier dans le répertoire
/modules/registrars/de votre installation WHMCS, de façon à obtenir le chemin/modules/registrars/whc/.Dans votre console d'administration WHMCS, allez à System Settings > Domain Registrars (dans les versions plus anciennes, Setup > Products/Services > Domain Registrars).
Repérez WHC dans la liste et sélectionnez Activate.
Connecter le module à votre compte WHC
Après l'activation, sélectionnez Configure à côté de WHC.
Saisissez votre identifiant client et votre clé API depuis la section API de votre Espace client.
Enregistrez les paramètres.
Votre WHMCS est maintenant connecté à WHC. Vous pouvez assigner WHC comme registraire pour vos TLD sous System Settings > Domain Pricing.
Ce que vous pouvez faire avec le module
Une fois connecté, le module prend en charge :
La vérification de la disponibilité des domaines
L'enregistrement, le renouvellement et le transfert
Le verrouillage et le déverrouillage de registraire
La récupération des codes EPP (codes de transfert)
L'obtention et la mise à jour des serveurs de noms
La mise à jour des coordonnées
Documentation de l'API
La documentation de l'API est la documentation publique de WHC, à l'image de WHC, pour l'API de gestion de domaines. Vous pouvez y accéder depuis la page API de votre nouvel Espace client (NCA).
C'est la référence pour chaque opération utilisée par le module, et ce dont vous avez besoin pour appeler l'API directement depuis vos propres scripts ou systèmes plutôt que par WHMCS. Elle répertorie chaque point de terminaison, les paramètres qu'il accepte et les réponses qu'il retourne.
Comportements importants à comprendre
L'étiquette API
Chaque domaine enregistré par l'API est automatiquement marqué d'une étiquette API dans votre Espace client WHC. Cela vous permet de repérer quels domaines ont été créés de façon programmatique.
Deux choses à noter :
L'étiquette API est appliquée automatiquement, mais elle n'est pas verrouillée. Vous pouvez la retirer à tout moment si vous n'en voulez pas.
WHC permet un maximum de deux étiquettes par domaine. L'étiquette API occupe l'un de ces deux emplacements. Si vous la retirez, les deux emplacements sont libres pour vos propres étiquettes.
Le renouvellement automatique est désactivé par défaut
Les domaines enregistrés par l'API et le module ont le renouvellement automatique désactivé par défaut. C'est intentionnel, afin que les enregistrements programmatiques ne se renouvellent pas automatiquement sans votre intention.
Si vous voulez qu'un domaine se renouvelle automatiquement, activez le renouvellement pour ce domaine vous-même après son enregistrement. Passez en revue régulièrement vos domaines enregistrés par l'API afin qu'aucun n'expire involontairement.
La Protection de domaine et l'API
La Protection de domaine WHC ne s'applique pas aux actions effectuées par l'API. La Protection de domaine protège normalement quatre opérations derrière une étape de vérification par courriel : la mise à jour des coordonnées, le retrait d'un verrou de registraire, la mise à jour des serveurs de noms et la récupération d'un code EPP. Ces étapes de vérification ne peuvent pas être appliquées à un appel d'API.
En activant et en utilisant l'API, vous acceptez que la Protection de domaine ne soit pas appliquée à ces quatre opérations lorsqu'elles sont effectuées par l'API ou le module. Gardez votre clé API en sécurité et traitez-la comme une information sensible.