addSSL Print

  • hosting, API
  • 0

Allows adding of SSL certificate to domain or website address pointing to your servers at Sive.Host : status -> OK. status -> Error, msj ->(array).

Request Parameters

Parameter Type Description Required
action string “addSSL” Required
serviceid string The service id code as per your Sive.Host client area. When you login to Sive.Host client area, you click on the active services, a list of all will appear, then click on the word "Active" next to the service, then the service page will appear, on the url of the page, you will see the number at the end of it. eg. if URL is https://sive.host/clientarea.php?action=productdetails&id=2633 , then the service id is 2633 in this case. Required
api_key string API key credentials as per Authentication instructions Required
api_secret string API secret credentials as per Authentication instructions Required
name string Name of the domain or subdomain to generate the autossl Required
debug string Put 0 to not return any debugging information, and put 1 to return debugging information Required

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
message string information regarding the action operation

Example Request (CURL)

<?php

$apiUrl = 'https://sive.host/includes/sivehost-api.php'; // Change to your API endpoint
$username = 'Ikhaka'; // required
$password = 'Mph#th9mi$'; // required

$postfields = array(
    'api_key' => 'G2dskdXb7BlDwlvbrD1zVEe5ZKQIybXn', // required 
    'api_secret' => 'CtIJVZf8OM1p4iLxwiKFjlU4bPVmEycS', // required
    'action' => 'addSSL',
    'serviceid' => '2639',
    'name' => 'siveict.co.za',
    'debug' => '1' //show any errors if any
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $apiUrl);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postfields));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password"); // Basic Authentication
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Use true in production with a valid SSL

$response = curl_exec($ch);

// Check for cURL errors
if (curl_errno($ch)) {
    echo 'cURL Error: ' . curl_error($ch);
}
    
curl_close($ch);

// Output response
echo $response;
?>

Example Response JSON

{"result":"success",
"message":"OK"
}

Error Responses

Error Message Cause
Unauthorized access! Request from unauthorized IP
Invalid API Key or secret. Incorrect API credentials
Invalid Product or Operating System. Unknown product or Operating System for that product
Missing action parameter. action not specified eg. BuyNow
Insufficient credit to place the order. Not enough account balance. Load credit on Sive.Host client area.
Invalid Payment Method. Valid options include Payment method not specified on payload.
cURL Error. cURL Error: Failed to connect to sive.host port 443 after 16410 ms: Couldn't connect to server

Version History

Version Changelog
1.0 Initial Version

Kas see vastus oli kasulik?
Back