The short answer: the side menu of the documentation has four groups. Get started explains the rules that apply to everything, Areas has one page for each part of your account, the API reference puts every operation on one page, and the Playground is for trying things out. Knowing this saves time: every question has a group where it belongs.
The four menu groups
| Group |
What it has |
When to open it |
| Get started |
Home, Get started with the API, Authentication and keys, Permissions and API rules. |
Before your first request, and whenever you have questions about errors, limits, pagination, retries or the Sandbox and Production modes. |
| Areas |
Domains, DNS, Hosting, Email, Servers, SMS, Email Center, Invoices and credit, Account and security, Catalog, Support, Extra products, Reseller, and Key and status. |
When you are about to automate a specific task: each page explains the area and lists its operations. |
| API reference |
Every operation on a single page, with a filter, each one leading to the page of its area. |
When you already know what you want to do and are looking for the right operation. |
| Playground |
Every operation, ready to try. |
To make a real request from your browser and see the answer. |
You can open each group from the menu: Get started with the API, API reference and Playground.
What every page has
| 1 |
At the top: the title, a sentence on what the page covers, two shortcut buttons (for example, Playground and See the reference) and an "On this page" card with the sections.
|
|
| 2 |
Just below: the "Updated on" date, the reading time and the View as Markdown and Copy page buttons.
|
|
| 3 |
The text: split into sections, each with its own link that you can copy and send.
|
|
| 4 |
At the end: the "Did not find what you were looking for?" box, which leads to the search and the Knowledge Base, and the Previous and Next links, in menu order.
|
|
How the pages fit together
The Get started pages explain what applies to every operation. The Areas pages explain each operation and point back to those rules when needed, instead of repeating them. The reference is built from the OpenAPI specification, the same one the API itself uses, so the list of operations follows what the API accepts. How to read an area, screen by screen: an area page.
RECOMMENDED PRODUCT Web hosting with cPanel Domain and SSL included, daily backups and the panel you already know. from $5.36/mo (3-year plan, with coupon) See plans |
Português
English
