Documentation de l'API de PlanetHoster

Cette documentation est séparée en commandes GET et POST. Toutes les méthodes API disponibles sont listées sous chaque catégorie.
SSL seulement: Nous demandons à ce que toutes les requêtes soient faites avec des connexions encryptées SSL/TLS afin de garantir l'intégrité des données confidentielles.
Méthodes HTTP supportés sont GET et POST. Si votre client ne supporte pas tous les méthodes HTTP vous pouvez passer outre la méthode avec le X-HTTP-Verb header HTTP.
Sauf si spécifié de façon différente dans la documentation de la méthode, tous les appels API réussis vont retourner un code HTTP avec un objet JSON.
Les erreurs sont retournées avec un code HTTP 4XX ou 5XX, un objet JSON avec les propriétés "error" (un message d'erreur) and "error_code" (optionnel, un integer).
Chaque string passé à/depuis l'API a besoin d'être encodé en UTF-8. Pour compatibilité maximum, vérifiez la normalisation UNF avant d'encoder en UTF-8.
L'API envoie des headers ETag et supporte le header If-None-Match
Sauf si spécifié autrement, toutes les méthodes API requièrent une authentification avec un api_user et une api_key
Quand vous voulez utiliser l'API, Vous devez spécifier une ou plusieurs IPs qui seront autorisées à accéder à l'API.

L'URL de base du Rest API est:

https://api.planethoster.net/reseller-api/

Compte/Informations

GET /test-connection

Testez la connexion API

Teste la connexion à l'API revendeur, avec la clé API et l'utilisateur API.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/test-connection'

Valeur retournée:

{
 "message": "Connection successful",
 "successful_connection": true
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found

GET /tld-prices

Montrez les prix des TLD.

Affiche les prix des noms de domaine pour l'enregistrement, le renouvellement et le transfert. Indique aussi si le TLD accepte la protection WHOIS et s'il requiert un code EPP pour le transfert.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/tld-prices'

Réponse suite à une opération réussie (Exemple)

{
 "message": "Successfully retrieved prices",
 "tlds": {
   ".fr" {
   "register": "12.09", // register for 1 year, price in USD
   "transfer": "12.09", // transfer, price in USD
   "renew": "12.09", // renew for 1 year, price in USD
   "transfer_requires_epp_code": true,
   "id_protection_supported": false
   },
   //... each TLD that we sell is returned in the format above
 }
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found

GET /account-info

Informations du compte

Retourne les informations pertinentes à votre compte Revendeur.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/account-info'

Valeur retournée:

{
 "message": "Account information successfully obtained",
 "credit_remaining": "500.00",
 "credit_currency": "USD"
 "num_active_orders": 2,
 "num_active_domains": 2
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found

GET /check-availability

Vérifier la disponibilité du domaine

Vérifie si un nom de domaine est disponible pour enregistrement.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/check-availability?sld=my-domain&tld=com'

Paramètres:

	Name	Type	Description
GET	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
GET	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie (Exemple avec domaine premium disponible):

   {
     "available": true,
     "message": "Available",
     "is_premium": true,
     "premium_register_price": "100.00", // registration price for 1 year in USD
     "premium_renew_price": "100.00" // renewal price for 1 year in USD
   }

Réponse suite à une opération réussie (Exemple avec domaine premium disponible):

   {
     "available": true,
     "message": "Available",
     "is_premium": true,
     "premium_register_price": "100.00", // registration price for 1 year in USD
     "premium_renew_price": "100.00" // renewal price for 1 year in USD
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Invalid TLD

GET /domain-info

Information du domaine

Récupére les informations pour un domaine que vous avez enregistré ou transféré avec succès .

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/domain-info?sld=my-domain&tld=com'

Paramètres:

	Name	Type	Description
GET	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
GET	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Domain info successfully obtained",
     "order_id": "1122",
     "is_transfer": false,
     "is_registration": true,
     "registration_date": "2016-01-01", // YYYY-MM-DD
     "expiry_date": "2017-01-01", // not present for domain transfers that haven't been completed
     "registration_status": "Active", // can be "Active", "Pending", "Pending Transfer" or "Cancelled"
     // registration_status_info offers more information about why the registration status is the way it is. Can be one of:
     //   "" (empty string), "transfer_in_progress", "invalid_epp_code", "awaiting_transfer_approval_email_response_from_client"
     //   "awaiting_client_removal_of_id_protection_for_transfer", "awaiting_client_removal_of_transfer_prohibited_status",
     //   "domain_status_prevents_transfer", "awaiting_transfer_approval_from_registry", "transfer_request_expired_or_denied"
     "registration_status_info": "",
     "purchase_status": "Paid", // one of "Paid" or "Unpaid"
     "id_protection": true, // whether or not WHOIS ID protection is enabled for the domain
     "domain_statuses": ["clientTransferProhibited"], // statuses on the domain at the registry. Not always present.
     "transfer_request_status": "Pending", // only present for domain transfers for ICANN tlds. One of "Pending" (waiting for email transfer approval by registrant), "Confirmed" (waiting for registry to approve the transfer), "Denied" (transfer denied), "RegistryApproved" (transfer approved)
     "transfer_request_denied_reason": "" // only present for domain transfers for ICANN tlds, and if the transfer was denied.
     "transfer_request_denied_at": "2016-06-01", // YYYY-MM-DD, only present for domain transfers for ICANN tlds, and if the transfer was denied.
     "transfer_request_confirmed_at": "2016-06-01" // YYYY-MM-DD, only present for domain transfers for ICANN tlds, and if the transfer was confirmed by the registrant by email
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

Obtenir les informations d'un domaine

GET /get-contact-details

Chercher les informations du contact

Retourne les informations de contact (information WHOIS) pour le nom de domaine actif.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/get-contact-details?sld=my-domain&tld=com'

Paramètres:

	Name	Type	Description
GET	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
GET	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Contact(s) successfully obtained",
     "contacts": [
       {
         "name": 'Ryan Smith',
         "company_name": "",
         "addr": {
           "address1": "123 Melrose Avenue",
           "address2": "",
           "address3": "",
           "city": "Montreal",
           "state": "Quebec",
           "postal_code": "H6W 6W6",
           "country": "CA" // country code
         },
         "phone_number": "15145555555",
         "fax": "",
         "email": "ryansmith@mydomain.com",
         "contact_type": "registrant",
         "phone_extension": "13", // optional, not always returned
         "statuses": ["clientTransferProhibited"], // optional, not always returned
       },
       // ... other contact objects would have different "contact_type" values, if there are other contacts for the returned domain.
     ]
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

GET /get-nameservers

Afficher les nameservers du domaine

Affiche les nameservers configurés pour un nom de domaine enregistré.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/get-nameservers?sld=my-domain&tld=com'

Paramètres:

	Name	Type	Description
GET	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
GET	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Nameserver(s) successfully obtained",
     "nameservers": [
       { "host": 'ns1.resellersite.com' },
       { "host": 'ns2.resellersite.com' },
       { "host": 'ns3.resellersite.com' },
     ]
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

GET /get-ph-dns-records

Montrez les enregistrements DNS PlanetHoster

Montre les enregistrements DNS pour un domaine actif enregistré chez PlanetHoster qui utilise au moins 1 nameserver de PlanetHoster (un de nsa.planethoster.net, nsb.planethoster, nsc.planethoster.net).

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/get-ph-dns-records?sld=my-domain&tld=com'

Paramètres:

	Name	Type	Description
GET	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
GET	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie:

   {
     "message": "DNS zone found on PlanetHoster nameserver(s)",
     "records": [
       {
         "type": "A", // can be "A", "AAAA" (for IPv6 IP addresses), "CNAME", "MX", "MXE" or "TXT"
         "hostname": "mydomain.com",
         "address": "199.188.199.21", // the IP address with which the hostname is associated
       },
       // etc...
     ]
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD or DNS zone doesn't exist on PlanetHoster nameserver(s)

GET /get-registrar-lock

Montrez l'état du statut de verrouillage

Affiche le statut de protection d'un domaine. Si un domaine est verrouillé, il ne peut être transféré vers un autre registraire. Il doit être déverrouillé au préalable. Voir Mise à jour du statut de protection d'un domaine pour plus de détails.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/reseller-api/get-registrar-lock?sld=my-domain&tld=com'

Paramètres:

	Name	Type	Description
GET	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
GET	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie:

   {
     "message": "Lock status successfully obtained",
     "is_locked": true
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD or DNS zone doesn't exist on PlanetHoster nameserver(s)

Sauvegarder/modifier les informations d'un domaine

POST /save-contact-details

Changez les informations de contact

Enregistre les informations du contact (information WHOIS) pour le nom de domaine actif.

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"registrant_address1": "123 Cherry Hill", "registrant_city": "Laval", "registrant_company_name": ...}' \
  'https://api.planethoster.net/reseller-api/save-contact-details'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'
POST	registrant_first_name	string	Prénom du contact Registrant du domaine - exemple: 'Todd'
POST	registrant_last_name	string	Nom du contact Registrant du domaine - exemple: 'Glass'
POST	registrant_email	string	Adresse mail du contact Registrant du domaine - example: 'toddglass@gmail.com'
POST	registrant_company_name	string	Nom de la compagnie ou de l'organisation pour laquelle le registrant enregistre le domaine. Peut être vide si pour usage personnel - exemple: 'PlanetHoster Inc.'
POST	registrant_address1	string	Adresse (numéro et rue) du contact Registrant du domaine - exemple: '123 Parkway Lane'
POST	registrant_address2	string	Adresse (Numéro et rue) de la deuxième résidence du contact Registrant du domainet. Peut être vide.
POST	registrant_city	number	Nom de la ville de résidence du contact Registrant du domaine - exemple: 'Montreal'
POST	registrant_postal_code		Code postal ou code ZIP du contact Registrant du domaine - exemple: '4444'
POST	registrant_state	number	Nom de l'état ou le la Province de résidence du contact Registrant du domaine - exemple: 'Quebec'
POST	registrant_country_code	string	Code à deux lettres du pays de résidence du contact Registrant du domaine. Voir [list](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - exemple: 'CA'
POST	registrant_phone	string	Numéro de téléphone y compris code régional du contact Registrant du domaine. Avec code international. - exemple: '+1.5145555555'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Contact(s) successfully saved",
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

POST /save-nameservers

Faire la mise à jour des NameServers

Affiche les nameservers configurés pour un nom de domaine enregistré. Les NameServers doivent exister et être valides.

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com", "ns1": "nsa.planethoster.net", "ns2": ...}' \
  'https://api.planethoster.net/reseller-api/save-nameservers'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'
POST	ns1	string	Nameserver primaire pour le domaine - exemple: 'ns1.resellersite.com'
POST	ns2	string	Nameserver secondaire pour le domaine - exemple: 'ns2.resellersite.com'
POST	ns3	string	Nameserver de backup pour le domaine - exemple: 'ns3.resellersite.com'
POST	ns4	string	Nameserver de backup pour le domaine por redondance - exemple: 'ns4.resellersite.com'
POST	ns5	string	Nameserver de backup pour le domaine por redondance - exemple: 'ns5.resellersite.com'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible)::

   {
     "message": "Nameserver(s) successfully saved",
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

POST /save-ph-dns-records

Faire la mise-à-jour de la zone DNS PlanetHoster

Met à jour les enregistrements DNS pour un nom de domaine actif enregistré chez PlanetHoster et qui utilise au moins 1 nameserver de PlanetHoster (un de nsa.planethoster.net, nsb.planethoster ou nsc.planethoster.net)

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com", "hostname1": "mydomain.com", "address1": "192.168.0.1", "type1": "A", "priority": ...}' \
  'https://api.planethoster.net/reseller-api/save-ph-dns-records'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'
POST	hostname1	string	Le nom d'hôte qui est associée avec l'entrée DNS - exemple: 'mydomain.com'
POST	address1	string	La valeur dépend du `type` donné. pour les entrées A et AAAA, c'est l'adresse IP. Pour les entrées CNAME, C'est le nom canonique lui-même. Pour les entrées MX et MXE, c'est l'exchange. Pour les entrées TXT, c'est les données TXT. Example: '199.188.199.18'
POST	type1	string	Un de 'A', 'AAAA', 'CNAME', 'MX', 'MXE' ou 'TXT' - exemple: 'A'
POST	priority1	integer	La priorité sont pour les entrées MX et MXE seulement - exemple: '14000'
POST	hostname2, address2, type2	string	Un de 'A', 'AAAA', 'CNAME', 'MX', 'MXE' or 'TXT' - exemple: 'A'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Successfully updated DNS record(s)",
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or "Error creating DNS zone"

POST /save-registrar-lock

Faire la mise à jour du statut de vérouillage du domaine

Active ou désactive le statut de protection d'un domaine. Un domaine protégé ne peut être transféré de chez PlanetHoster vers un autre registraire sans avoir ce statut désactivé au préalable.

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com", "lock_action": "Lock"}' \
  'https://api.planethoster.net/reseller-api/save-registrar-lock'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'
POST	lock_action	string	Un de 'Lock' ou 'Unlock' - exemple: 'Lock'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Lock status successfully saved (Locked)",
     "is_locked": true
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

Autres

POST /email-epp-code

Obtenir l'Authinfo

Envoie par courriel le code EPP (aussi appelé Auth Info) au propriétaire pour un domaine en particulier.

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com"}' \
  'https://api.planethoster.net/reseller-api/email-epp-code'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Epp code successfully sent to registrant email",
     "epp_code_sent_to": "admin@mydomain.com"
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

POST /register-domain

Enregistrer nouveau domaine

Tente d'enregistrer un domaine pour 1 à 10 années.

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com", "period": 1, "ns1": "nsa.planethoster.net", "ns2": "nsb.planethoster.net", ...}' \
  'https://api.planethoster.net/reseller-api/register-domain'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'
POST	period	integer	Nombre d'années à enregistrer le domaine, de 1 à 10 seulement. Notez que tous les TLD peuvent être enregistrés jusqu'a 10 ans, voir la commande `tld-prices` pour plus d'info - exemple: '1'
POST	ns1	string	Nameservers utilisés à utiliser pour le DNS lookup du domaine enregistré - exemple: 'ns1.resellersite.com'
POST	ns2	string	Nameserver secondaire existant (pour redondance) à utiliser pour le DNS lookup du domaine enregistré - exemple: 'ns2.resellersite.com'
POST	id_protection	boolean	Commander ou non la protection WHOIS ID pour ce domaine. Notez que la protection ID n'est pas offerte pour tous les TLDs. Voir `tld-prices` pour plus d'info - exemple: '1'
POST	registrant_first_name	string	Prénom du contact Registrant du domaine - exemple: 'Todd'
POST	registrant_last_name	string	Nom du contact Registrant du domaine - exemple: 'Glass'
POST	registrant_email	string	Adresse mail du contact Registrant du domaine - exemple: 'toddglass@gmail.com'
POST	registrant_company_name	string	Nom de la compagnie ou l'organisation pour lequel le contact Registrant enregistre le nom de domaine. Peut être vide si pour usage personnel. - exemple: 'PlanetHoster Inc.'
POST	registrant_address1	string	Numéro et nom de la rue de la compagnie ou résidence primaire du contact Registrant - exemple: '123 Parkway Lane'
POST	registrant_address2	string	Numéro et nom de la rue de la résidence secondaire du contact Registrant. Peut être vide.
POST	registrant_city	number	Nom de la ville de résidence du contact Registrant - exemple: 'Montreal'
POST	registrant_postal_code		Code Postal ou Code ZIP de la résidence primaire du Contact Registrant - exemple: '4444'
POST	registrant_state	number	Nom de l'état ou la province de résidence du Contact Registrant - exemple: 'Quebec'
POST	registrant_country_code	string	Code de pays à deux lettre du pays dans lequel réside le Contact Registrant. Voir [liste](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - exemple: 'CA'
POST	registrant_phone	string	Numéro de téléphone comprenant le code régional avec caractères numériques seulement. Avec ou sans code international au début. - exemple: '5145555555'
POST	ns3	string	Nameserver tertiaire existant (pour redondance) pour utiliser pour le DNS lookup du domaine enregistré - exemple: 'ns3.resellersite.com'
POST	ns4	string	Nameserver existant (pour redondance) pour utiliser pour le DNS lookup - example: 'ns4.resellersite.com'
POST	ns5	string	Enregistrer le domaine même s'il s'agit d'un domaine premium, qui pourrait être beaucoup plus cher.
POST	register_if_premium	boolean	Enregistrer le domaine même s'il s'agit d'un domaine premium, qui pourrait être beaucoup plus cher.
POST	use_planethoster_nameservers	string	Ne mettre cette option à '1' que lorsque vous utilisez 'nsa.planethoster.net', 'nsb.planethoster.net', and 'nsc.planethoster.net' comme valeurs ns1, ns2 et ns3 (ns4 et ns5 devraient rester vides). Cette option crée une zone DNS pour le domaine sur les Nameservers après l'enregistrement.
POST	admin_first_name, admin_last_name, etc..	string	Information du contact Administratif (pour le WHOIS) du domaine
POST	tech_first_name, tech_last_name, etc..	string	Information du contact Technique (pour le WHOIS) du domaine
POST	billing_first_name, billing_last_name, etc..	string	Information du contact de la Facturation (pour le WHOIS) du domaine. Seulement disponible pour certains TLDs.
POST	addtl_fields	assoc. array	tableau associatif (hash map) de paires clé-valeur qui représentent des champs supplémentaires spécifiques pour le TLD qui est en cours d'enregistrement. Voir l'index des champs disponibles additionels pour chaque TLD ici. Notez que certains champs additionels sont requis!

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

 {
   "message": "Domain registration order successfully created", // always returned on success
   "order_id": "1112", // always returned on success
   "order_total": "19.95", // always returned on success
   "expiry_date": "2017-01-20", // not always present, depends on the TLD
 }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain registration failed - invalid value for parameter 'registrant_country_code'

POST /renew-domain

Renouvellement d'un domaine existant

Renouvelle un nom de domaine déjà actif pour 1 à 10 ans.

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com", "period": 1}' \
  'https://api.planethoster.net/reseller-api/renew-domain'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'
POST	period	integer	Nombre d'années qu'il faut renouveler le domaine - exemple: '1'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Domain renewal order created successfully",
     "order_id": "1212",
     "order_total": "9.95"
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Domain not found for given SLD and TLD

POST /transfer-domain

Lancer le transfert d'un nom de domaine

Transfère un nom de domaine de votre registraire actuel vers nous

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com", "epp_code": YYYYY}' \
  'https://api.planethoster.net/reseller-api/transfer-domain'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'
POST	epp_code	string	Transfer secret est un secret de transfert (clé de transfert), une clé ou un code - exemple: 'a!8/e!__Ph'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Successfully transfer launch",
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Error deleting DNS zone: DNS zone does not exist on PlanetHoster DNS servers

POST /delete-ph-dns-zone

Supprimer la zone DNS PlanetHoster

Supprime la zone DNS sur les serveurs DNS PlanetHoster pour le nom de domaine donné..

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"sld": "my-domain", "tld": "com"}' \
  'https://api.planethoster.net/reseller-api/delete-ph-dns-zone'

Paramètres:

	Name	Type	Description
POST	sld	string	Domaine sans la particule de fin. Exemple: 'mydomain' sans le '.com'
POST	tld	string	TLD sans le point. Exemple: 'com'

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

   {
     "message": "Successfully deleted DNS zone on PlanetHoster DNS servers",
   }

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found or Error deleting DNS zone: DNS zone does not exist on PlanetHoster DNS servers

Voici certains exemples de requêtes utilisant : cURL:

Recevoir informations d'utilisateur :

Show/hide example

curl -X GET \
     -d 'api_key=XXXXX&api_user=XXXXX' \
     "https://api.planethoster.net/reseller-api/test-connection"

HTTP/1.1 200 OK
Content-Type: application/json
date: Jul 16 2020 01:28:44 GMT
---
{
    "message": "Connection successful",
    "successful_connection": "true",
}

Notre API Web est organisée de telle sorte que l'intégration avec elle est aussi simple que possible. Chaque requête HTTP est soit un GET ou POST, chaque requête nécessite une ` api_key` et un ` api_user`, qui vous sont fournis sur inscription, et la réponse HTTP est toujours formatée en tant que JSON. Des erreurs peuvent survenir, et quand elles surviennent, nous retournons les clés:

error_code: (integer), an error code

et:

error: (string), an error message

Pour chaque commande API qui est décrite ici, Nous vous ferons savoir pour chaque erreur ou condition de succès.

Note: Si ces champs ne sont pas présents dans le JSON retourné, la commande API a réussi. La réussite veut bien sur dire différentes choses pour différentes commandes: pour l'enregistrement des domaines cela veut dire que le domaine à été enregistré avec succès, pour le transfert du domaine cela veut dire que la requête de transfert à été envoyé au bon registraire et pour le renouvellement de domaine, cela veut dire que le domaine à été renouvelé pour le nombre d'années spécifié dans la commande. Une requête `get-nameservers` va simplement retourner les nameservers associé avec le domaine, etc.

Les demandes de l'API consistent de champs (noms paramètres) et leur valeur qui sont envoyées dans soit les paramètres de requête de l'URL ou le corps POST de la requête (pour requêtes GET et POST respectivement). Chaque champ pour chaque commande API est documentée comme ayant un «type», soit comme un string, un integer, un boolean, une date, ou un hashmap (tableau associatif).

Pour les champs string, ce sont simplement les strings eux-mêmes.
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?sld=mydomain&tld=com"
--
Pour les champs integer, ce sont la représentation en string de l'integer.
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?period=1"
---
Pour les champs boolean, '1' est toujours traité comme 'true', et "" (string vide) est traité comme 'false'.
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?id_protection="
--
Pour les champs 'date', ils sont représentés comme ceci : "YYYY-MM-DD".
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?somedatefield=2017-01-01"
---
Pour les hashmaps, Ils sont représentés comme ceci:
"https://api.planethoster.net/domain-reseller/register-domain?fieldname[key1]=val1&fieldname[key2]=val2"

Notez que tous les noms de champs et leurs valeurs doivent être URL-encoded. Par exemple, en PHP, utilisez les fonctions `urlencode` ou `http_build_query`. Les espaces dans les noms de champs et valeurs peuvent être encodés à `+` ou `%20`. Les deux sont acceptés.

Pour les réponses, qui sont en JSON, toutes les dates sont retournés dans le même format ("YYYY-MM-DD"), en strings. Les booleans sont retournés en JSON `true` et `false`, et les montants monétaires sont retournés en tant que strings formatés comme ceci: "9.99".

Panel revendeur

Notre Panel Revendeur sera votre portail pour la gestion de vos domaines qui auront été revendus avec nous. Depuis le site du Panel Revendeur, vous pourrez renouveler et gérer le cycle de vie des domaines que vous avez avec nous.

Module Registrar WHMCS

Notre module WHMCS offre la possibilité pour nos revendeurs de noms de domaine d'utiliser WHMCS pour enregistrer, renouveler, transférer et gérer des noms de domaine avec PlanetHoster. La première étape pour commencer est de devenir un revendeur de noms de domaine enregistré avec PlanetHoster. Ceci est gratuit, et peut être fait en se connectant à votre compte existant et en cliquant sur l'onglet "Revendeur" dans votre espace membre et en activant votre compte de revendeur de noms de domaine. Si vous n'avez pas un compte PlanetHoster existant, Vous pouvez créer un nouveau compte ici. Après que votre compte soit créé et que vous y soyez connecté, vous pouvez suivre les étapes précédentes pour activer votre compte revendeur.

Caractéristiques:

Enregistrement/transfert/renouvellement de domaines
Synchronisation de domaine automatique (sync)
Modifications DNS
Modifications de contacts WHOIS
Enregistrements privés (Protection ID)
Verrouillage/déverrouillage du registraire
Requête de Auth Code/EPP
Gestion DNS (A, AAAA, CNAME, MX, TXT) si les NameServers sont ceux de PlanetHoster (nsa.planethoster.net, nsb.planethoster.net, nsc.planethoster.net)

Développement continu: Ce module est open-source et vous pouvez y contribuer pour le rendre meilleur. Ajoutez une requête de fonctionnalité ou créer une requête pull ici

Installation

Notre module WHMCS est disponible en ligne ici ou ici.

Pour l'installer, simplement bougez ou copiez le dossier "planethoster" sous le dossier "(whmcs)/modules/registrars/".

Après cela, dans l'administration WHMCS, cliquez sur "Setup" >> "Products/Services" >> "Domain Registrars" dans le menu déroulant.

Cherchez pour "Planethoster" et cliquez sur le bouton "Activate".

Copiez et coller l' API_User et la API_Key dans le champ texte correspondant.

Une fois fait, cliquez sur "Save Changes".

Après cela, dans WHMCS, cliquez sur "Setup" >> "Products/Services" >> "Domain Pricing" dans le menu déroulant.

Ajoutez un nouveau TLD, et configurez Auto Registration à "Planethoster" >> Save Changes.

How-to Setup WHMCS?

Librairies de Langages/GitHub

PlanetHoster a fait repository publiques pour le moment avec la librairie Golang & le module registrar WHMCS

Exemples débutants/QuickStart

Comme mentionné dans notre survol, quand vous enregistrez comme un revendeur avec PlanetHoster, vous recevrez une clé API et un code utilisateur API. Ces deux clés sont essentielles car elles sont requises pour chaque commande que vous envoyez à l'API. Toutes les commandes suivantes seront sous la forme :
```
curl -XGET (or POST) -d 'key1=X&key2=Y&key3=Z&api_key=XXXXX&api_user=XXXXX' 'API_URL'
```
Ici je vais utiliser XXXXX comme wildcard pour la vraie clé et id.

Donc, disons que je souhaite enregistrer le domaine testingplanethoster.com. Je voudrais tout d'abord savoir si le domaine est disponible ou non:
```
curl -XGET -d 'sld=testingplanethoster&tld=com&api_key=XXXXX&api_user=XXXXX' 'https://api.planethoster.net/reseller-api/check-availability'
```
l'API retourne:
```
{
    "available": true,
    "message": "Available",
    "is_premium": true,
    "premium_register_price": "80.00",
    "premium_renew_price": "80.00"
}
```

Heureusement, notre nouveau domaine est disponible, mais il est aussi un domaine premium, qui est plus cher qu'un .com régulier. Étant donné que cela va coûter plus que prévu, ce serait une bonne idée de vérifier si nous avons assez de crédit dans notre compte en premier avant de continuer avec l'enregistrement:

curl -XGET -d 'api_key=XXXXX&api_user=XXXXX' 'https://api.planethoster.net/reseller-api/account-info'

l'API retourne:

{
    "message": "Account information successfully obtained",
    "credit_remaining": "150.00",
    "credit_currency": USD,
    "num_active_orders": 2,
    "num_active_domains": 2
}

Maintenant que nous savons que nous avons assez de fonds, nous pouvons procéder avec l'enregistrement. Nous devrons entrer l'information du propriétaire du domaine dans la requête et aussi pour combien de temps nous allons enregistrer ce domaine et les NameServers que nous voulons pour utiliser le nouveau domaine. Comme vous pouvez voir, cela fait une requête curl POST assez longue.

curl -XPOST -d 'id_protection=1&ns1=nsa.planethoster.net&ns2=nsb.planethoster.net&period=1&registrant_address1=123+Cherry+Hill&registrant_city=Laval&registrant_company_name=&registrant_country_code=CA&registrant_email=john%40hancock.com&registrant_first_name=John&registrant_last_name=Hancock&registrant_phone==%2B1.5145555555&registrant_postal_code=11111&registrant_state=Quebec®ister_if_premium=1&sld=testingplanethoster&tld=com&api_key=XXXXX&api_user=XXXXX' 'https://api.planethoster.net/reseller-api/register-domain'

l'API retourne:

{
    "message": "Domain registration order successfully created",
    "order_id": "1112",
    "order_total": "80.00",
    "expiry_date": "2017-06-14"
}

Comme vous pouvez le remarquer, J'ai aussi activé la protection ID whois et j'ai eu à spécifier que cela est ok à enregistrer même si cela est un domaine premium.

Nous avons maintenant un nom de domaine enregistré, mias ce n'est pas terminé. Parce que nous voulons se sentir plus sécurisé, nous voulons vérouiller notre domaine en place de telle façon qu'il ne peut être transféré. Pour ce faire, nous émetterons la requête suivante:
```
curl -XPOST -d 'lock_action=Lock&sld=testingplanethoster&tld=com&api_key=XXXXX&api_user=XXXXX' 'https://api.planethoster.net/reseller-api/save-registrar-lock'
```
l'API retourne:
```
{
    "message": "Lock status successfully saved (Locked)",
    "is_locked": true
}
```
Comme vous avez peut-être déjà remarqué, quand on enregistre le domaine, nous configurons les NameServers à nsa et nsb.planethoster.net . Ceci nous laisse contrôler enregistrements de zone DNS à travers l'API, comme pour les nameservers PlanetHoster. Nous allons créer un enregistrement A et un enregistrement MX, qui devraient être un besoin basique pour un site avec des mails..
```
curl -XPOST -d 'hostname1=testingplanethoster.com&address1=192.168.0.1&type1=A&hostname2=testingplanethoster.com&address2=mail.testingplanethoster.com&priority3=0&type3=MX&sld=mydomainname&tld=com&api_key=XXXXX&api_user=XXXXX'
```
l'API retourne:
```
{
    "message": "Successfully updated DNS record(s)",
}
```
Avançons dans le temps un peu, un an plus tard. vous voudrez renouveler le domaine pour, disons, 2 ans. Voici la requête qui va nous laisser faire ceci.
```
curl -XPOST -d 'sld=testingplanethoster&tld=com&period=2&api_key=XXXXX&api_user=XXXXX' 'https://api.planethoster.net/reseller-api/renew-domain'
```
l'API retourne:
```
{
    "message": "Domain renewal order created successfully",
    "order_id": "1212"
    "order_total": "160.00"
}
```
Ceci devrait couvrir les bases de l'utilisation de l'API. Il y a toutefois plusieurs autres méthodes disponibles qui couvrent une variété d'opérations. Je vous suggère de lire leur documentation pour avoir une meilleure idée de quoi notre API peut faire pour vous.

Librairie Golang pour l'API

Go (Souvent désigné comme golang) est un langage de programmation open source créé par Google en 2007 par Robert Griesemer , Rob Pike et Ken Thompson. Il est compilé , statiquement écrit dans la tradition de Algol et C, avec la collecte des ordures, écriture structurelle limitée , sécurité de la mémoire et caractéristiques de programmation de style CSP .

Exemple main.go:

package main

import (
  "log"
  "github.com/PlanetHoster/api_Golang/phapi"
)

const (
  APIKEY  = "mykey"
  APIUSER = "myuser"
)

func main() {
  sld := "exemple"
  tld := "com"
  //Aucune validation n'est faite à ce point
  api := phapi.New(APIKEY, APIUSER)

  //Vérifie si la connexion est valide
  if err := api.Test(); err != nil {
    log.Fatalln("Erreur de connexion", err)
  } else {
    log.Println("Connexion réussi")
  }

  //Retrouve les informations de votre compte revendeur
  log.Println(api.AccountInfo())

  //Vérifie la disponibiltié d'un domain
  log.Println(api.DomainAvailable(sld, tld))

  //Plus d'information sur un domaine
  log.Println(api.DomainInfo(sld, tld))

  //Retourne les informations du WHOIS du domaine
  log.Println(api.Whois(sld, tld))

  //Retourne les nameservers du domaine
  log.Println(api.Nameservers(sld, tld))

  //Si les DNS sont avec PlanetHoster, les retournes
  log.Println(api.DNSRecords(sld, tld))

  //Listes toutes les extensions disponibles
  log.Println(api.TLDPrices())

  //Enregistre un domaine (commenté pour éviter les erreurs)

  /*  domain := phapi.NewDomainData(&phapi.ContactDomain{
      FirstName:   "Gabriel",
      LastName:    "PlanetHoster",
      Email:       "test@monmail.com",
      CompanyName: "",
      Address1:    "123 Chemin des Planètes",
      Address2:    "",
      City:        "Paris",
      PostalCode:  "1234567",
      State:       "Paris",
      CountryCode: "FR",
      Phone:       "0176604143",
    }, "nsa.planethoster.net", "nsb.planethoster.net")
    domain.NS3 = "nsc.planethoster.net"
    fmt.Println(api.RegisterDomain(sld, tld, 1, domain))
  */
}

Glossaire des termes

TLD: Top-level domain, comme '.com', '.ca', '.fr', '.co.uk', etc.
SLD: Domaine sans le TLD, comme 'google', 'example', 'mydomain', etc.
Opérateur de registraire de nom de domaines: Souvent appelés "registraires", ce sont les organisations qui sont responsables du maintien des données administratives et la gestion de l'enregistrement des noms de domaine pour les TLDs pour lesquels ils sont responsables
Registrar de nom de domaine: Souvent appelés "registrars", ce sont des organisations qui permettent aux clients d'enregistrer , de renouveler, de transférer et de gérer les noms de domaine pour divers TLDs. PlanetHoster est un registrar de nom de domaines.
Revendeur de nom de domaine: Ce sont des organisations qui utilisent d'autres registrars (au lieu des registres directement) pour leurs enregistrements de domaine , les renouvellements, les transferts et la gestion. Ils achètent des domaines d'un registrar, puis les revendent à leurs clients.
Domaines Premium: Ce sont les domaines qui, selon les registraires, sont plus précieux, et donc plus chers pour l'enregistrement, le renouvellement et le transfert.
Code EPP: Aussi appelé "Auth Info", c'est le code secret qui est nécessaire afin de transférer votre domaine à un autre registrar. Ce n'est pas tous les TLDs qui ont besoin d'un code pour le transfert, mais la plupart oui.
WHOIS: L'information WHOIS est l'Information qui est publique suite à l'enregistrement d'un domaine. Il comprend le nom , l'email, l'adresse physique de la personne inscrite, le registrar , etc.
Protection ID: Aussi appelé WHOIS ID Protection, ou similaire, ceci est un service que vous pouvez commander chez un registrar qui remplace vos informations WHOIS avec d'autres informations valides, généralement pour éviter le spam.
Nameserver: Les nameservers sont associés à un nom de domaine au niveau du registre, et ils disent aux DNS (Domain Name System) quel serveur DNS à utiliser pour chercher l'adresse IP à lequel votre domaine est associé, entre autres.
Zone DNS: Une zone DNS est créée sur les nameserver(s) pour votre domaine pour dire aux clients DNS qui recherchent votre domaine (comme un fureteur web) d'utiliser ce NameServer comme autorité pour savoir où trouver l'adresse IP associée à votre nom de domaine, entre autres.
Requête de transfert de nom de domaine: Une fois qu'une requête de transfert de nom de domaine est faite avec PlanetHoster, le registrant du domaine doit approuver le transfert en vérifiant le mail qu'il a inscrit dans 'Registrant Email' et suivre les étapes dans ce mail. Une fois cela fait, une requête de transfert est faite depuis PlanetHoster au registre correspondant. La requête n'est pas approuvée immédiatement, Cela peut prendre jusqu'à 5 jours pour être approuvé ou refusé.
Verrouillage de domaine: Les nom de domaines verrouillés ne peuvent être transférer vers un autre registrar. Ceci est principalement une mesure de précaution pour le registrant, pour que personne ne puisse tenter de transférer leur domaine vers un autre registrar ou sous leur nom. Avant qu'un transfert soit fait, le domaine doit être déverrouillé au registrar source.

Champs additionnels/TLD

Certains TLDs ont besoin de champs additionnels pour être envoyés à l'API lors de l'enregistrement du domaine. Les noms des champs ont besoin d'être URL-encoded, ainsi que la valeur des champs. Par exemple, si vous enregistrez un nom de domaine avec le TLD .us, le champ 'Nexus Category' avec la valeur 'C11':

/register-domain?addtl_fields[Nexus Category]=C11

devient:

/register-domain?addtl_fields[Nexus&20Category]=C11

== .us ==

* Field Name: "Nexus Category"
    - Type: Choice
    - Valid Values: "C11", "C12", "C21", "C31", "C32"
    - Value Descriptions: see https://www.a2hosting.com/kb/getting-started-guide/registering-a-domain1/nexus-codes-and-us-domain-registration
    - Required: False

* Field Name: "Nexus Country"
    - Type: Text
    - Required: True

* Field Name: "Application Purpose"
    - Type: Choice
    - Valid Values: "Business use for profit", "Non-profit business", "Club", "Association", "Religious Organization", "Personal Use", "Educational purposes", "Government purposes"
    - Required: False

== .co.uk ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "IND", "FIND", "LTD", "PLC", "PTNR", "LLP", "STRA", "RCHAR", "IP", "SCH", "FOTHER", "GOV", "CRC", "STAT", "OTHER", "FOTHER", "FCORP"
    - Value Descriptions: "UK Individual", "Non-UK Individual (representing self)", "UK Limited Company", "UK Public Limited Company", "UK Partnership", "UK LLP", "UK Sole Trader", "UK Registered Charity", "UK Industrial/Provident Registered Company", "UK School", "Other Foreign", "UK Government Body", "UK Corporation by Royal Charter", "UK Statutory Body", "UK Entity (other)", "Non-UK Organization (other)", "Non-UK Corporation"
    - Required: False

* Field Name: "Company ID Number"
    - Type: Text
    - Required: False

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

* Field Name: "WHOIS Opt-out"
    - Type: Boolean
    - Valid Values: '1', ''

== .net.uk ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "IND", "FIND", "LTD", "PLC", "PTNR", "LLP", "STRA", "RCHAR", "IP", "SCH", "FOTHER", "GOV", "CRC", "STAT", "OTHER", "FOTHER", "FCORP"
    - Value Descriptions: "UK Individual", "Non-UK Individual (representing self)", "UK Limited Company", "UK Public Limited Company", "UK Partnership", "UK LLP", "UK Sole Trader", "UK Registered Charity", "UK Industrial/Provident Registered Company", "UK School", "Other Foreign", "UK Government Body", "UK Corporation by Royal Charter", "UK Statutory Body", "UK Entity (other)", "Non-UK Organization (other)", "Non-UK Corporation"
    - Required: False

* Field Name: "Company ID Number"
    - Type: Text
    - Required: False

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

== .org.uk ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "IND", "FIND", "LTD", "PLC", "PTNR", "LLP", "STRA", "RCHAR", "IP", "SCH", "FOTHER", "GOV", "CRC", "STAT", "OTHER", "FOTHER", "FCORP"
    - Value Descriptions: "UK Individual", "Non-UK Individual (representing self)", "UK Limited Company", "UK Public Limited Company", "UK Partnership", "UK LLP", "UK Sole Trader", "UK Registered Charity", "UK Industrial/Provident Registered Company", "UK School", "Other Foreign", "UK Government Body", "UK Corporation by Royal Charter", "UK Statutory Body", "UK Entity (other)", "Non-UK Organization (other)", "Non-UK Corporation"
    - Required: False

* Field Name: "Company ID Number"
    - Type: Text
    - Required: False

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

== me.uk ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "IND", "FIND", "LTD", "PLC", "PTNR", "LLP", "STRA", "RCHAR", "IP", "SCH", "FOTHER", "GOV", "CRC", "STAT", "OTHER", "FOTHER", "FCORP"
    - Value Descriptions: "UK Individual", "Non-UK Individual (representing self)", "UK Limited Company", "UK Public Limited Company", "UK Partnership", "UK LLP", "UK Sole Trader", "UK Registered Charity", "UK Industrial/Provident Registered Company", "UK School", "Other Foreign", "UK Government Body", "UK Corporation by Royal Charter", "UK Statutory Body", "UK Entity (other)", "Non-UK Organization (other)", "Non-UK Corporation"
    - Required: False

* Field Name: "Company ID Number"
    - Type: Text
    - Required: False

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

== .plc.uk ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "IND", "FIND", "LTD", "PLC", "PTNR", "LLP", "STRA", "RCHAR", "IP", "SCH", "FOTHER", "GOV", "CRC", "STAT", "OTHER", "FOTHER", "FCORP"
    - Value Descriptions: "UK Individual", "Non-UK Individual (representing self)", "UK Limited Company", "UK Public Limited Company", "UK Partnership", "UK LLP", "UK Sole Trader", "UK Registered Charity", "UK Industrial/Provident Registered Company", "UK School", "Other Foreign", "UK Government Body", "UK Corporation by Royal Charter", "UK Statutory Body", "UK Entity (other)", "Non-UK Organization (other)", "Non-UK Corporation"
    - Required: False

* Field Name: "Company ID Number"
    - Type: Text
    - Required: False

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

== .ltd.uk ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "IND", "FIND", "LTD", "PLC", "PTNR", "LLP", "STRA", "RCHAR", "IP", "SCH", "FOTHER", "GOV", "CRC", "STAT", "OTHER", "FOTHER", "FCORP"
    - Value Descriptions: "UK Individual", "Non-UK Individual (representing self)", "UK Limited Company", "UK Public Limited Company", "UK Partnership", "UK LLP", "UK Sole Trader", "UK Registered Charity", "UK Industrial/Provident Registered Company", "UK School", "Other Foreign", "UK Government Body", "UK Corporation by Royal Charter", "UK Statutory Body", "UK Entity (other)", "Non-UK Organization (other)", "Non-UK Corporation"
    - Required: False

* Field Name: "Company ID Number"
    - Type: Text
    - Required: False

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

== .uk ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "IND", "FIND", "LTD", "PLC", "PTNR", "LLP", "STRA", "RCHAR", "IP", "SCH", "FOTHER", "GOV", "CRC", "STAT", "OTHER", "FOTHER", "FCORP"
    - Value Descriptions: "UK Individual", "Non-UK Individual (representing self)", "UK Limited Company", "UK Public Limited Company", "UK Partnership", "UK LLP", "UK Sole Trader", "UK Registered Charity", "UK Industrial/Provident Registered Company", "UK School", "Other Foreign", "UK Government Body", "UK Corporation by Royal Charter", "UK Statutory Body", "UK Entity (other)", "Non-UK Organization (other)", "Non-UK Corporation"
    - Required: False

* Field Name: "Company ID Number"
    - Type: Text
    - Required: False

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

== .ca ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "CCO", "CCT", "RES", "GOV", "EDU", "ASS", "HOP", "PRT", "TDM", "TRD", "PLT", "LAM", "TRS", "ABO", "INB", "LGR", "OMK", "MAJ"
    - Value Descriptions: "Corporation (Canada or Canadian province or territory)", "Canadian citizen", "Permanent Resident of Canada", "Government or government entity in Canada", "Canadian Educational institution", "Canadian Unincorporated Association", "Canadian Hospital", "Partnership Registered in Canada", "Trade-mark registered in Canada (by a non-Canadian owner)", "Canadian Trade union", "Canadian Political party", "Canadian Library Archive or Museum", "Trust established in Canada", "Aboriginal Peoples (individuals or groups) indigenous to Canada", "Indian Band recognized by the Indian Act of Canada", "Legal Representative of a Canadian Citizen or Permanent Resident", "Official mark registered in Canada", "Her Majesty the Queen"
    - Description: Legal type of registrant contact
    - Required: False

* Field Name: "CIRA Agreement"
    - Type: Boolean
    - Valid Values: '1', ''
    - Description: Tick to confirm you agree to the CIRA Registration Agreement shown below
English version
Version française
    - Required: True

* Field Name: "WHOIS Opt-out"
    - Type: Boolean
    - Valid Values: '1', ''
    - Description: Tick to hide your contact information in CIRA WHOIS (only available to individuals)

== .quebec ==

* Field Name: "Intended use"
    - Type: Text
    - Required: True

* Field Name: "Variants"
    - Type: Text
    - Required: False

== .es ==

* Field Name: "ID Form Type"
    - Type: Choice
    - Valid Values: "0", "1", "3"
    - Value Descriptions: "Generic ID", "VAT ID", "Resident alien ID"
    - Required: False

* Field Name: "ID Form Number"
    - Type: Text
    - Required: True

* Field Name: "Legal Form"
    - Type: Choice
    - Valid Values: "1", "39", "47", "59", "68", "124", "150", "152", "164", "181", "197", "203", "229", "269", "286", "365", "434", "436", "439", "476", "510", "524", "525", "554", "560", "562", "566", "608", "612", "713", "717", "744", "745", "746", "747", "877", "878", "879"
    - Value Descriptions: "Individual", "Economic Interest Group", "Association", "Sports Association", "Professional Association", "Savings Bank", "Community Property", "Community of Owners", "Order or Religious Institution", "Consulate", "Public Law Association", "Embassy", "Local Authority", "Sports Federation", "Foundation", "Mutual Insurance Company", "Regional Government Body", "Central Government Body", "Political Party", "Trade Union", "Farm Partnership", "Public Limited Company", "Sports Association", "Civil Society", "General Partnership", "General and Limited Partnership", "Cooperative", "Worker-owned Company", "Limited Company", "Spanish Office", "Temporary Alliance of Enterprises", "Worker-owned Limited Company", "Regional Public Entity", "National Public Entity", "Local Public Entity", "Others", "Designation of Origin Supervisory Council", "Entity Managing Natural Areas"
    - Required: True

* Field Name: "Admin Id"
    - Type: Text
    - Required: True

* Field Name: "Admin Id Type"
    - Type: Choice
    - Valid Values: "0", "1", "3"
    - Value Descriptions: "Generic ID", "National Identity", "Resident alien ID"
    - Required: True

* Field Name: "Terms and Conditions"
    - Type: Choice
    - Valid Values: "", "1"
    - Value Descriptions: "Please Select", "I agree to the terms and conditions"
    - Required: True

== .sg ==

* Field Name: "RCB Singapore ID"
    - Type: Text
    - Description: RCB/Singapore ID
    - Required: True

* Field Name: "Registrant Type"
    - Type: Choice
    - Valid Values: "Individual", "Organisation"
    - Required: False

== .com.sg ==

* Field Name: "RCB Singapore ID"
    - Type: Text
    - Description: RCB/Singapore ID
    - Required: True

* Field Name: "Registrant Type"
    - Type: Choice
    - Valid Values: "Individual", "Organisation"
    - Required: False

== .edu.sg ==

* Field Name: "RCB Singapore ID"
    - Type: Text
    - Description: RCB/Singapore ID
    - Required: True

* Field Name: "Registrant Type"
    - Type: Choice
    - Valid Values: "Individual", "Organisation"
    - Required: False

== .net.sg ==

* Field Name: "RCB Singapore ID"
    - Type: Text
    - Description: RCB/Singapore ID
    - Required: True
* Field Name: "Registrant Type"
    - Type: Choice
    - Valid Values: "Individual", "Organisation"
    - Required: False

== .org.sg ==

* Field Name: "RCB Singapore ID"
    - Type: Text
    - Description: RCB/Singapore ID
    - Required: True

* Field Name: "Registrant Type"
    - Type: Choice
    - Valid Values: "Individual", "Organisation"
    - Required: False

== .per.sg ==

* Field Name: "RCB Singapore ID"
    - Type: Text
    - Description: RCB/Singapore ID
    - Required: True

* Field Name: "Registrant Type"
    - Type: Choice
    - Valid Values: "Individual", "Organisation"
    - Required: False

== .tel ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "Natural Person", "Legal Person"
    - Required: False

* Field Name: "WHOIS Opt-out"
    - Type: Boolean
    - Valid Values: '1', ''

== .it ==

* Field Name: "Type of Registrant Entity"
    - Type: Choice
    - Valid Values: "1", "2", "3", "4", "5", "6", "7"
    - Value Descriptions: "Italian and foreign natural persons", "Companies/one man companies", "Freelance workers/professionals", "non-profit organizations", "public organizations", "other subjects", "non natural foreigners"
    - Description: Legal type of registrant
    - Required: False

* Field Name: "Tax ID"
    - Type: Text
    - Required: True

* Field Name: "Publish Personal Data"
    - Type: Boolean
    - Valid Values: '1', ''

* Field Name: "Accept Section 3 of .IT registrar contract"
    - Type: Boolean
    - Valid Values: '1', ''

* Field Name: "Consent for Processing of Information"
    - Type: Boolean
    - Valid Values: '1', ''

* Field Name: "Consent for Dissemination and Accessibility via the Internet"
    - Type: Boolean
    - Valid Values: '1', ''

* Field Name: "Explicit Acceptance of Registry Terms"
    - Type: Boolean
    - Valid Values: '1', ''

== .de ==

* Field Name: "Tax ID"
    - Type: Text
    - Required: True

* Field Name: "Address Confirmation"
    - Type: Boolean
    - Valid Values: '1', ''
    - Description: Please tick to confirm you have a valid German address

== .com.au ==

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID Type"
    - Type: Choice
    - Valid Values: "ABN", "ACN", "Business Registration Number"
    - Required: False

* Field Name: "Eligibility Name"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID Type"
    - Type: Choice
    - Valid Values: "Australian Company Number (ACN)", "ACT Business Number", "NSW Business Number", "NT Business Number", "QLD Business Number", "SA Business Number", "TAS Business Number", "VIC Business Number", "WA Business Number", "Trademark (TM)", "Other - Used to record an Incorporated Association number", "Australian Business Number (ABN)"
    - Required: False

* Field Name: "Eligibility Type"
    - Type: Choice
    - Valid Values: "Charity", "Citizen/Resident", "Club", "Commercial Statutory Body", "Company", "Incorporated Association", "Industry Body", "Non-profit Organisation", "Other", "Partnership", "Pending TM Owner  ", "Political Party", "Registered Business", "Religious/Church Group", "Sole Trader", "Trade Union", "Trademark Owner", "Child Care Centre", "Government School", "Higher Education Institution", "National Body", "Non-Government School", "Pre-school", "Research Organisation", "Training Organisation"
    - Required: False

* Field Name: "Eligibility Reason"
    - Type: Choice
    - Valid Values: "Domain name is an Exact Match Abbreviation or Acronym of your Entity or Trading Name.", "Close and substantial connection between the domain name and the operations of your Entity."

== .net.au ==

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID Type"
    - Type: Choice
    - Valid Values: "ABN", "ACN", "Business Registration Number"
    - Required: False

* Field Name: "Eligibility Name"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID Type"
    - Type: Choice
    - Valid Values: "Australian Company Number (ACN)", "ACT Business Number", "NSW Business Number", "NT Business Number", "QLD Business Number", "SA Business Number", "TAS Business Number", "VIC Business Number", "WA Business Number", "Trademark (TM)", "Other - Used to record an Incorporated Association number", "Australian Business Number (ABN)"
    - Required: False

* Field Name: "Eligibility Type"
    - Type: Choice
    - Valid Values: "Charity", "Citizen/Resident", "Club", "Commercial Statutory Body", "Company", "Incorporated Association", "Industry Body", "Non-profit Organisation", "Other", "Partnership", "Pending TM Owner  ", "Political Party", "Registered Business", "Religious/Church Group", "Sole Trader", "Trade Union", "Trademark Owner", "Child Care Centre", "Government School", "Higher Education Institution", "National Body", "Non-Government School", "Pre-school", "Research Organisation", "Training Organisation"
    - Required: False

* Field Name: "Eligibility Reason"
    - Type: Choice
    - Valid Values: "Domain name is an Exact Match Abbreviation or Acronym of your Entity or Trading Name.", "Close and substantial connection between the domain name and the operations of your Entity."

== .org.au ==

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID Type"
    - Type: Choice
    - Valid Values: "ABN", "ACN", "Business Registration Number"
    - Required: False

* Field Name: "Eligibility Name"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID Type"
    - Type: Choice
    - Valid Values: "Australian Company Number (ACN)", "ACT Business Number", "NSW Business Number", "NT Business Number", "QLD Business Number", "SA Business Number", "TAS Business Number", "VIC Business Number", "WA Business Number", "Trademark (TM)", "Other - Used to record an Incorporated Association number", "Australian Business Number (ABN)"
    - Required: False

* Field Name: "Eligibility Type"
    - Type: Choice
    - Valid Values: "Charity", "Citizen/Resident", "Club", "Commercial Statutory Body", "Company", "Incorporated Association", "Industry Body", "Non-profit Organisation", "Other", "Partnership", "Pending TM Owner  ", "Political Party", "Registered Business", "Religious/Church Group", "Sole Trader", "Trade Union", "Trademark Owner", "Child Care Centre", "Government School", "Higher Education Institution", "National Body", "Non-Government School", "Pre-school", "Research Organisation", "Training Organisation"
    - Required: False

* Field Name: "Eligibility Reason"
    - Type: Choice
    - Valid Values: "Domain name is an Exact Match Abbreviation or Acronym of your Entity or Trading Name.", "Close and substantial connection between the domain name and the operations of your Entity."

== .asn.au ==

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID Type"
    - Type: Choice
    - Valid Values: "ABN", "ACN", "Business Registration Number"
    - Required: False

* Field Name: "Eligibility Name"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID Type"
    - Type: Choice
    - Valid Values: "Australian Company Number (ACN)", "ACT Business Number", "NSW Business Number", "NT Business Number", "QLD Business Number", "SA Business Number", "TAS Business Number", "VIC Business Number", "WA Business Number", "Trademark (TM)", "Other - Used to record an Incorporated Association number", "Australian Business Number (ABN)"
    - Required: False

* Field Name: "Eligibility Type"
    - Type: Choice
    - Valid Values: "Charity", "Citizen/Resident", "Club", "Commercial Statutory Body", "Company", "Incorporated Association", "Industry Body", "Non-profit Organisation", "Other", "Partnership", "Pending TM Owner  ", "Political Party", "Registered Business", "Religious/Church Group", "Sole Trader", "Trade Union", "Trademark Owner", "Child Care Centre", "Government School", "Higher Education Institution", "National Body", "Non-Government School", "Pre-school", "Research Organisation", "Training Organisation"
    - Required: False

* Field Name: "Eligibility Reason"
    - Type: Choice
    - Valid Values: "Domain name is an Exact Match Abbreviation or Acronym of your Entity or Trading Name.", "Close and substantial connection between the domain name and the operations of your Entity."

== .id.au ==

* Field Name: "Registrant Name"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID"
    - Type: Text
    - Required: True

* Field Name: "Registrant ID Type"
    - Type: Choice
    - Valid Values: "ABN", "ACN", "Business Registration Number"
    - Required: False

* Field Name: "Eligibility Name"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID"
    - Type: Text
    - Required: False

* Field Name: "Eligibility ID Type"
    - Type: Choice
    - Valid Values: "Australian Company Number (ACN)", "ACT Business Number", "NSW Business Number", "NT Business Number", "QLD Business Number", "SA Business Number", "TAS Business Number", "VIC Business Number", "WA Business Number", "Trademark (TM)", "Other - Used to record an Incorporated Association number", "Australian Business Number (ABN)"
    - Required: False

* Field Name: "Eligibility Type"
    - Type: Choice
    - Valid Values: "Charity", "Citizen/Resident", "Club", "Commercial Statutory Body", "Company", "Incorporated Association", "Industry Body", "Non-profit Organisation", "Other", "Partnership", "Pending TM Owner  ", "Political Party", "Registered Business", "Religious/Church Group", "Sole Trader", "Trade Union", "Trademark Owner", "Child Care Centre", "Government School", "Higher Education Institution", "National Body", "Non-Government School", "Pre-school", "Research Organisation", "Training Organisation"
    - Required: False

* Field Name: "Eligibility Reason"
    - Type: Choice
    - Valid Values: "Domain name is an Exact Match Abbreviation or Acronym of your Entity or Trading Name.", "Close and substantial connection between the domain name and the operations of your Entity."

== .asia ==

* Field Name: "Legal Type"
    - Type: Choice
    - Valid Values: "naturalPerson", "corporation", "cooperative", "partnership", "government", "politicalParty", "society", "institution"
    - Required: False

* Field Name: "Identity Form"
    - Type: Choice
    - Valid Values: "passport", "certificate", "legislation", "societyRegistry", "politicalPartyRegistry"
    - Required: False

* Field Name: "Identity Number"
    - Type: Text
    - Required: True

== .pro ==

* Field Name: "Profession"
    - Type: Text
    - Description: Indicated professional association recognized by government body
    - Required: True

== .coop ==

* Field Name: "Contact Name"
    - Type: Text
    - Description: A sponsor is required to register .coop domains. Please enter the information here
    - Required: True

* Field Name: "Contact Company"
    - Type: Text
    - Required: True

* Field Name: "Contact Email"
    - Type: Text
    - Required: True

* Field Name: "Address 1"
    - Type: Text
    - Required: True

* Field Name: "Address 2"
    - Type: Text
    - Required: False

* Field Name: "City"
    - Type: Text
    - Required: True

* Field Name: "State"
    - Type: Text
    - Required: False

* Field Name: "ZIP Code"
    - Type: Text
    - Required: True

* Field Name: "Country"
    - Type: Text
    - Description: 2 Letter Country Code
    - Required: True

* Field Name: "Phone CC"
    - Type: Text
    - Description: Phone Country Code eg 1 for US & Canada, 44 for UK
    - Required: True

* Field Name: "Phone"
    - Type: Text
    - Required: True

== .be ==

* Field Name: "VATNO"
    - Type: Text
    - Description: VAT number
    - Required: False

== .fr ==

* Field Name: "Siren"
    - Type: Text
    - Required: False
    - Must Match Regular Expression: \d{3} \d{3} \d{3}

== .re ==

* Field Name: "Siren"
    - Type: Text
    - Required: False
    - Must Match Regular Expression: \d{3} \d{3} \d{3}

== .pm ==

* Field Name: "Siren"
    - Type: Text
    - Required: False
    - Must Match Regular Expression: \d{3} \d{3} \d{3}

== .tf ==

* Field Name: "Siren"
    - Type: Text
    - Required: False
    - Must Match Regular Expression: \d{3} \d{3} \d{3}

== .wf ==

* Field Name: "Siren"
    - Type: Text
    - Required: False
    - Must Match Regular Expression: \d{3} \d{3} \d{3}

== .yt ==

* Field Name: "Siren"
    - Type: Text
    - Required: False
    - Must Match Regular Expression: \d{3} \d{3} \d{3}

En addition avec les codes d'erreur JSON, les erreurs viennent avec un message (error parameter) et un code numérique (error_code parameter). Le message d'erreur est fait pour être lu par un humain, alors que les codes numériques doivent être lu par votre application.

5000	General error
5001	Network issues
5002	Internal error occured
5003	Error authenticating to our API
5004	Not authorized to access our API, or just this API method.
5005	Domain is unavailable for registration or transfer.
5006	Domain doesn't exist in our database.
5007	PlanetHoster doesn't sell this TLD.
5008	Domain is cancelled in PlanetHoster's system.

Retrouvez PlanetHoster sur Google+ et @PlanetHoster et trouvez de la lecture ici et ici TOS

L'URL de base du Rest API est:

https://api.planethoster.net/world-api/

Compte/Informations

GET /test-connection

Testez la connexion API

Teste la connexion à l'API revendeur, avec la clé API et l'utilisateur API.

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/world-api/test-connection'

Valeur retournée:

{
 "message": "Connection successful",
 "successful_connection": true
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	No reseller found
5004	World account not found

GET /get-accounts

Récupérez les informations du compte

Affiche les informations du compte The world ainsi que tous les sous comptes World

curl -X GET \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  'https://api.planethoster.net/world-api/get-accounts'

Réponse suite à une opération réussie (Exemple)

{
  {
    "nb_active_or_suspended_accounts": 1,
    "reseller_id": "XXXXX",
    "total_available_ressources": {
      "cpu": 7,
      "io": 15,
      "mem": 15
    },
    "world_accounts": [
      {
        "domain": "test-domain.com",
        "hostname": "world-server.test.planethoster.net",
        "id": 1234,
        "location": "ca",
        "ressources": {
          "cpu": 1,
          "io": 1,
          "mem": 1
        },
        "status": "Active"
      }
    ]
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	Active or suspended accounts not found

Actions sur hébergement World

POST /create-account

Créez un compte World

Crée un hébergement world, assigne les ressources demandées

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"domain": "test-domain.com", "country": "ca", "cpu": 1, "mem": 1, "io": 1, "ls": true, "with_cpanel": false}' \
  'https://api.planethoster.net/world-api/create-account'

Paramètres:

	Name	Type	Description
POST	domain	string	Le nom de domaine complet
POST	country	string	La localisation du serveur. Possibilités: ("fr" ou "ca")
POST	cpu	integer	Le nombre de cpu attribué au compte
POST	mem	integer	Le nombre de memoire attribué au compte (GB)
POST	io	integer	Le nombre de I/O attribué au compte (MB/s)
POST	ls	boolean	Sélectionnez un serveur litespeed (client VIP uniquement)
POST	with_cpanel	boolean	Sélection du panneau de contrôle avec World ou cPanel

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

{
  "account_created": true,
  "server_hostname": "world-server.planethoster.com",
  "server_ip": "199.16.XX.XXX",
  "id": "1234",
  "username": "username",
  "password": "XXXXXXXXX",
  "cms_config": {
    "admin_username": "username",
    "admin_pass": "XXXXXXXXX"
  }
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	Failed to create account or invalid domain name

POST /suspend-account

Suspension d'un compte world

Procède à la suspension d'un compte World

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"id": 123, "reason": "Suspension reason"}' \
  'https://api.planethoster.net/world-api/suspend-account'

Paramètres:

	Name	Type	Description
POST	id	string	Le id du compte World (Récupérable via le /get-accounts)
POST	reason	string	La raison de la suspension

Réponse suite à une opération réussie (Exemple sans domaine premium disponible)::

{
  "account_suspended": true,
  "message": "Successfully suspend account",
  "suspension_reason": "Suspension reason",
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	No world account found, missing parameters or account already suspend

POST /unsuspend-account

Réactivation d'un compte World

Réactive le compte world suspendu

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"id": 123}' \
  'https://api.planethoster.net/world-api/unsuspend-account'

Paramètres:

	Name	Type	Description
POST	id	string	Le id du compte World (Récupérable via le /get-accounts)

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

{
  "account_unsuspended": true,
  "message": "Successfully unsuspend account",
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	World account is not suspended

POST /modify-ressources

Modifiez les ressources d'un compte World

Modifie les ressources associées à un compte World

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"id": 123, "cpu": 1, "mem": 1, "io": 1}' \
  'https://api.planethoster.net/world-api/modify-ressources'

Paramètres:

	Name	Type	Description
POST	id	string	Le id du compte World (Récupérable via le /get-accounts)
POST	cpu	integer	Le nombre de cpu attribué au compte
POST	mem	integer	Le nombre de memoire attribué au compte (GB)
POST	io	integer	Le nombre de I/O attribué au compte (MB/s)

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

{
  "cpu_updated": true,
  "errors": [],
  "io_updated": false,
  "mem_updated": true,
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	Invalid ressources values or not enough available ressources

POST /install-cms

Installation d'un CMS sur un compte World

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"id": 123, "cms": "wp"}' \
  'https://api.planethoster.net/world-api/install-cms'

Paramètres:

	Name	Type	Description
POST	id	string	Le id du compte World (Récupérable via le /get-accounts)
POST	cms	string	Le nom du CMS à installer ("wp","joomla","drupal","presta")

Réponse suite à une opération réussie:

{
  "errors": [],
  "admin_username": "username",
  "admin_pass": "XXXXXXXXX"
}

Codes d'erreur JSON possibles:

error_code	Raison
5000	CMS Invalide

Actions sur hébergement The World (Compte parent)

POST/upgrade-plan

Augmentez les ressources

Augmente les ressources associées au compte The World

curl -X POST \
  -H "X-API-KEY: XXXXX" \
  -H "X-API-USER: XXXXX" \
  -H "Content-Type: application/json" \
  -d '{"cpu": 1, "mem": 1, "io": 1}' \
  'https://api.planethoster.net/world-api/upgrade-plan'

Paramètres:

	Name	Type	Description
POST	cpu	integer	Le nombre de cpu attribué au compte
POST	mem	integer	Le nombre de memoire attribué au compte (GB)
POST	io	integer	Le nombre de I/O attribué au compte (MB/s)

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

{
    "message": "Successfully upgrade your plan",
    "price_of_upgrades": "56.55",
    "credit_remaining": "8375.43",
    "total_ressources": {
        "cpu": 24,
        "mem": 24,
        "io": 24
    },
    "available_ressources": {
        "cpu": 18,
        "mem": 18,
        "io": 18
    },
}

Codes d'erreur JSON possibles:

error_code	Reason
5000	Error creating order, not enough credit or invalid ressources values

error_code: (integer), an error code

et:

error: (string), an error message

Pour chaque commande API qui est décrite ici, Nous vous ferons savoir pour chaque erreur ou condition de succès.

Les demandes de l'API consistent de champs (noms paramètres) et de leur valeur qui sont envoyées comme paramètres via l'URL (GET) ou le corps (POST). Chaque champ pour chaque commande API est documentée comme ayant un «type», soit comme un string, un integer, un boolean, une date, ou un hashmap (tableau associatif).

Pour les champs string, ce sont simplement les strings eux-mêmes.
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?sld=mydomain&tld=com"
--
Pour les champs integer, ce sont la représentation en string de l'integer.
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?period=1"
---
Pour les champs boolean, '1' est toujours traité comme 'true', et "" (string vide) est traité comme 'false'.
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?id_protection="
--
Pour les champs 'date', ils sont représentés comme ceci : "YYYY-MM-DD".
Exemple: "https://api.planethoster.net/domain-reseller/register-domain?somedatefield=2017-01-01"
---
Pour les hashmaps, Ils sont représentés comme ceci:
"https://api.planethoster.net/domain-reseller/register-domain?fieldname[key1]=val1&fieldname[key2]=val2"

Notez que tous les noms de champs et leurs valeurs doivent être URL-encoded. Par exemple, en PHP, utilisez les fonctions `urlencode` ou `http_build_query`. Les espaces dans les nom de champs et valeurs peuvent être encodées à `+` ou `%20`. Les deux sont acceptés.

Pour les réponses, qui sont en JSON, toutes les dates sont retournées dans le même format ("YYYY-MM-DD"), en strings. Les booleans sont retournés en JSON `true` et `false`, et les montants monétaires sont retournées en tant que strings formatés comme ceci: "9.99".

Documentation de l'API de PlanetHoster

Détails de l'implémentation

Méthodes API

Compte/Informations

GET /test-connection

Valeur retournée:

Codes d'erreur JSON possibles:

GET /tld-prices

Réponse suite à une opération réussie (Exemple)

Codes d'erreur JSON possibles:

GET /account-info

Valeur retournée:

Codes d'erreur JSON possibles:

GET /check-availability

Paramètres:

Réponse suite à une opération réussie (Exemple avec domaine premium disponible):

Réponse suite à une opération réussie (Exemple avec domaine premium disponible):

Codes d'erreur JSON possibles:

GET /domain-info

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

Obtenir les informations d'un domaine

GET /get-contact-details

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

GET /get-nameservers

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

GET /get-ph-dns-records

Paramètres:

Réponse suite à une opération réussie:

Codes d'erreur JSON possibles:

GET /get-registrar-lock

Paramètres:

Réponse suite à une opération réussie:

Codes d'erreur JSON possibles:

Sauvegarder/modifier les informations d'un domaine

POST /save-contact-details

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

POST /save-nameservers

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible)::

Codes d'erreur JSON possibles:

POST /save-ph-dns-records

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

POST /save-registrar-lock

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

Autres

POST /email-epp-code

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

POST /register-domain

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

POST /renew-domain

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

POST /transfer-domain

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

POST /delete-ph-dns-zone

Paramètres:

Réponse suite à une opération réussie (Exemple sans domaine premium disponible):

Codes d'erreur JSON possibles:

Exemples de requêtes

Recevoir informations d'utilisateur :

Bases de l'API PlanetHoster