Comment utiliser l’API

Introduction

Dans les lignes qui suivent, nous allons vous expliquer comment utiliser un API (Application Programming Interface) que PlanetHoster met à votre disposition pour configurer l’achat de domaines et de comptes World de vos propres clients sans que vous ayez à passer par votre espace membre.

Il est à noter que cet article a été écrit à l’intention des différents revendeurs ou des clients ayant des connaissances avancées.

Les sujets suivants y sont abordés :

• les informations d’accès à l’API;
• la revente de domaines (API domaine);
• l’hébergement (World API).

Note : Le glossaire de PlanetHoster contient  des explications sur de multiples sujets et peut être consulté pour clarifier certains termes.

Prérequis

Saisissez dans votre navigateur web l’adresse suivante : https://my.planethoster.com.

Accès à l’interface

Dans le menu, cliquez sur Mon compte -> API.

Informations d’accès

La section Informations d’accès vous fournit plusieurs informations dont vous aurez besoin pour utiliser l’API :

Vérification des informations d’accès

Voici comment connaître les informations d’accès et procéder à quelques vérifications :

• Repérez votre clé en tant qu’usager (API User) et la clé de l’API (API Key), car elles sont requises dans l’en-tête HTTP.
• Assurez-vous que le Statut de votre compte est Actif.
• Avec le Crédit restant, confirmez que vous avez votre minimum de 10 crédits.
  • Au besoin, le bouton Ajouter des fonds vous permet de vous procurer du crédit.
  • En regard des domaines, vous pourrez ainsi faire les actions suivantes : enregistrement de domaine, transfert de domaine, renouvellement de domaine et ajout du « id protection ».
  • Pour le plan The World, les crédits sont nécessaires pour l’action « upgrade_plan », qui consiste à augmenter les ressources maximales qui peuvent être allouées.
• Vous devez aussi mettre vos IP sur une liste blanche d'adresses IP. Les IPs de vos serveurs sont indiquées sous IPs autorisées.
  • Pour autoriser une nouvelle IP, vous n’avez qu’à la saisir dans le le champ Autoriser l’IP et à cliquer sur le bouton Ajouter.
• Les IP internes à PH seront ajoutées plus rapidement.

Il n’est pas permis d’autoriser des adresses IP externes pour l’API, sauf si le client a une facture qui démontre que l’IP lui est bien attribuée. Cette vérification cause des délais.

Accès à la documentation de l’API

Pour accéder à la documentation de l’API :

1. Cliquez sur le bouton Documentation de l’API.¹

2. Vous pouvez alors consulter la documentation de l’API.

Maintenant que nous connaissons les informations d’accès, nous pouvons décrire les deux fonctions principales de l’API, à savoir la revente de domaines (API domaine) et l’hébergement (World API).

API domaine

Cette API sécurisée vous permet d’interroger notre service web pour des fonctionnalités telles que :

• vérifier la disponibilité d’un domaine;
• afficher les fonds présents sur votre compte PlanetHoster;
• enregistrer un domaine;
• changer les informations du WHOIS;
• demander les prix de reventes par TLD;
• modifier les serveurs de nom d’un domaine;
• verrouiller/déverrouiller un domaine;
• récupérer le Authinfo/EPP.

Avant toute chose, lorsque vous placez des commandes sur notre plateforme, nous utilisons le crédit dans votre compte pour les payer. Cela fait, nous veillons alors à accomplir toutes les actions requises de notre côté, à savoir : enregistrer le domaine, le renouveler, etc.

Comment gérer un domaine

Lorsqu’un domaine est actif, vous le verrez dans votre compte et vous pourrez le gérer à votre guise. Pour ce faire :

1. Accédez à la Documentation de l’API (tel qu’expliqué précédemment).
2. Cliquez ensuite sur l’onglet Reseller API :

Comment interconnecter votre système de facturation

Si vous utilisez WHMCS comme système de revente et de gestion de domaines et que vous désirez l’interconnecter directement à PlanetHoster, nous vous fournissons une extension que vous pouvez facilement installer en quelques minutes.

Pour ce faire, il suffit de cliquer sur le bouton Module WHMCS² :

Prix des domaines

En tant que revendeur de domaines, il s’avère fort utile, pour chaque extension, d’en connaître aisément les différents prix.

Le bouton Prix des domaines donne accès à un tableau de même nom conçu à cette fin :

Dans ce tableau, vous trouverez, pour chaque extension :

• Son Prix d’enregistrement (1 an).
• Son Prix de transfert.
• Son Prix du renouvellement (1 an).

La liste déroulante Filtres s’avère fort utile pour vous aider à cibler des domaines répondant à des plages de prix définies :

Le champ Rechercher est aussi à votre disposition pour trouver les particularités d’une extension précise :

Comment ajouter des fonds

1. Veuillez cliquer sur le bouton Ajouter des fonds :

2. Vous serez alors dirigé vers l’interface Aperçu de votre espace membre.
   • Pour savoir comment ajouter les fonds, veuillez vous référer à l’article Comment fonctionne l’interface aperçu.

World API

Avec l’API d’hébergement web World Unlimited, vous pouvez débloquer un monde infini de possibilités. Ainsi, il vous est possible, entre autres choses :

• de créer des comptes d’hébergement World à la volée;
• d’automatiser des tâches récurrentes;
• d’intégrer des hébergements dans votre propre panneau de contrôle.

Pour ce faire, après avoir autorisé l’adresse IP qui fera les demandes à l’API, veuillez consulter la documentation de l’API, laquelle expose les différentes méthodes disponibles. Vous y aurez accès via l’URL https://apidoc.planethoster.com/fr/#tag/Gestion-des-Hebergements et en cliquant sur l’onglet Gestion des hébergements :

1. Pour accéder à la documentation de l’API, vous pouvez aussi saisir le lien à https://apidoc.planethoster.com/fr/ dans votre navigateur. ↩︎
2. Pour interconnecter le système de facturation, saisissez l’URL https://my.planethoster.com/downloads/planethoster_whmcs_module_v0.1.2.zip dans votre navigateur. ↩︎