Introduction
In the following, we will explain how to use an API (Application Programming Interface) provided by PlanetHoster to set up the purchase of domains and World accounts for your own customers, without having to go through your member area.
It should be noted that this article has been written for the resellers or customers having advanced knowledge in mind.
Following subjects are covered:
- access informations;
- domains reselling (Domain API);
- hosting (World API).
Note: The PlanetHoster Glossary contains explanations on multiple topics and can be consulted to clarify certain terms.
Prerequisites
Enter the following address in your web browser: https://my.planethoster.com.
Access to the Interface
In the menu, click on My Account -> API.
Access Informations
The Access Informations section provides you with several pieces of information you will need to use the API:
How to Verify Access Informations
Here is how to know access informations and make necessary verifications:
- Locate the API User and the API Key, as these are required in the HTTP header.
- Make sure your account Status is Active.
- With Credit Remaining, confirm that you have your minimum of 10 credits.
- If required, the Add Funds button allows you to purchase credit.
- Regarding domains, you will thus be able to do the following actions: domain registration, domain transfer, domain renewal and adding “id protection”.
- For The World plan, credits are needed for the “upgrade_plan” action, which consists of increasing the maximum resources that can be allocated.
- You must also whitelist your IPs. The IPs of your servers are listed under Whitelisted IPs.
- To authorize a new IP, simply enter it in the Whitelisted IP field and click on the Add button.
- IPs that are internal at PH will be added more quickly.
External IP addresses cannot be authorized for the API unless the customer has an invoice proving that the IP address has been assigned to him. This verification process causes delays.
How to Access to the API Documentation
To access to the documentation about the API:
- Please click on the button API Documentation.1
- At this point, you can read the documentation of the API.
Now that you know the access information, we can describe the two main functions of the API, that are the domain resale (Domain API) and the hosting (World API).
Domain API
This secure API allows you to query our web service for features such as:
- check domain availability;
- view funds in your PlanetHoster account;
- register a domain;
- change WHOIS information;
- request resale prices by TLD;
- change domain nameservers;
- lock/unlock a domain;
- retrieve Authinfo/EPP.
First and foremost, when you place orders on our platform, we use the credit in your account to pay for them. Once that is done, we then take care of all the necessary actions on our end: registering the domain, renewing it and so on.
How to Manage a Domain
When a domain is active, you will see it in your account, and you can manage it at your convenience. To do so:
- Access to the documentation of the API (as explained previously).
- Then click on the Reseller API tab:
How to Link Your Billing System
If you are using WHMCS as your shopping cart and domain management solution, and you want to link it directly to PlanetHoster, we have provided an extension that you can easily install in just a few minutes.
To do so, please click on the WHMCS Module button2:
How to Know Domain Prices
As a domain reseller, it is very useful to know the different prices for each extension.
The Domain Prices button provides access to a table of the same name, designed for this purpose:
In this table, you will find, for each extension:
- its Register Price (1 year);
- its Transfer Price;
- its Renew Price (1 year).
To help you target domains within defined price ranges, the Filters drop-down list is very useful:
You can also use the Search field to find the particulars of a specific extension:
How to Add funds
- Please click on the button Add Funds:
- You will then be redirected to the Overview in your member area.
- To know how to add funds, please refer to the article How to Use the Overview Interface.
World API
With the World Unlimited web hosting API, you can unlock an infinite world of possibilities. Among other things, you can:
- create World hosting accounts on the fly;
- automate recurring tasks;
- integrate hosts into your own control panel.
To do this, after authorizing the IP address that will make the requests to the API, please consult the API documentation, which sets out the various methods available. You can access it via the URL https://apidoc.planethoster.com/en#tag/Hostings-Management and by clicking on the Hostings Management tab:
- The documentation is available at https://apidoc.planethoster.com/en/. ↩︎
- You can also enter the URL https://my.planethoster.com/downloads/planethoster_whmcs_module_v0.1.2.zip in your browser. ↩︎