BuyDomain
Register an available domain through WHMCS and create the related order and invoice.
Endpoint: https://sive.host/modules/addons/shapi/sh-api.php
Method: POST using application/x-www-form-urlencoded.
Consequential action: may purchase, delete, replace credentials, or remove data. Access is limited to directly owned records or explicitly assigned Partner-managed client services after both relationships are verified.
Important behavior
- SHAPI checks availability, configured TLD pricing, and account credit before creating an order.
- Calling this action can consume account credit and create a payable invoice.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
action | string | Yes | Exact SHAPI action name shown in this article. |
api_key | string | Yes | Client API key generated in the Sive.Host SHAPI page. |
api_secret | string | Yes | Secret paired with the API key. Send it only in the POST body. |
domain | domain name | Yes | Available domain to register. |
regperiod | integer 1-10 | No | Registration period in years; default 1. |
nameserver1 | domain name | No | First nameserver. |
nameserver2 | domain name | No | Second nameserver. |
nameserver3 | domain name | No | Third nameserver. |
nameserver4 | domain name | No | Fourth nameserver. |
idnlanguage | string | No | Optional IDN language code. |
Example request
Set the four environment variables from the authenticated SHAPI page. Do not put credentials in source control or URLs.
curl --request POST 'https://sive.host/modules/addons/shapi/sh-api.php' \
--user "${SHAPI_HTTP_USER}:${SHAPI_HTTP_PASSWORD}" \
--header 'Accept: application/json' \
--data-urlencode "action=BuyDomain" \
--data-urlencode "api_key=${SHAPI_API_KEY}" \
--data-urlencode "api_secret=${SHAPI_API_SECRET}" \
--data-urlencode "domain=example.co.za" \
--data-urlencode "regperiod=1"Response
SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.
{
"result": "success",
"domain": "example.co.za",
"regperiod": 1,
"orderid": 1001,
"domainids": [
2001
],
"invoiceid": 3001
}Common errors
Unauthorized access!: source IP or HTTP Basic authentication failed.Invalid API Key or secret.: the customer key is wrong, disabled, or deleted.Unable to retrieve an active service owned by this client.: the service is inactive or belongs to another client.Missing required parameters.: one or more required fields were omitted.
SHAPI documentation version 2.0 — generated from the current endpoint contract.
