This document describes the Simply.com RESTful JSON API.
Please note we reserve the right to block and ban users who abuse the API.
The login information Nis given in the base URI and must be provided with each request.
Example: https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]
1 | The version of the API you are calling |
---|---|
accountname | Your Simply.com account name. Example: S123456 |
apikey | The API key assigned to your Simply.com account. Can be found in your controlpanel. |
The following libraries are availiable for use.
PHP | https://github.com/simplycom/api-php |
---|
Returns a list of all products for the given account.
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
GET https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/my/products/
In order to place an order with us, a valid credit card is required to be set up and active in your Simply.com controlpanel.
domain | An array of information about the domain. | array |
---|---|---|
domain[name] | The name of the domain, in the format "example.com" | string |
domain[action] | The action you wish to perform on the domain. Can be either "transfer" or "register". Must match status of given domain. | string |
password | Optional. The given password you wish the product to have. If left empty a random password is generated. | string |
coupon | Optional. | string |
autorenew | Optional. Set the product to automatic renewal | bool |
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
POST https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/order/dnsservice
{
"password": "somepassword",
"domain": {
"name": "example.com",
"action": "transfer"
},
"autorenew": true
}
<?php
$json = array(
'password' => 'somepassword',
'domain' => array('name' => 'example.com', 'action' => 'transfer'),
'autorenew' => true,
);
$ch = curl_init('https://api.simply.com/1/UE123456/654321/order/dnsservice/');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($json));
$response = curl_exec($ch);
$response_json = json_decode($response);
var_dump($response_json);
?>
{ "status": 200, "message": "success", "payment": { "amount": 100 } }
<?php
$domains = array('example.com',
'example.dk',
'example.co.uk',
'example.org',
/* ... */
);
foreach ( $domains as $domain ) {
$json = array(
'domain' => array('name' => $domain, 'action' => 'register'),
'autorenew' => true,
);
$ch = curl_init('https://api.simply.com/1/UE123456/654321/order/dnsservice/');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($json));
$response = curl_exec($ch);
$response_json = json_decode($response);
var_dump($response_json);
unset($ch);
}
?>
Query the availability status of a domain.
domain | The name of the domain, in the format "example.com". IDNA format recommended. |
---|
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
GET https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/domaincheck/example.com
<?php
$ch = curl_init('https://api.unoeuro.com/1/UE123456/654321/domaincheck/example.com/');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($json));
$response = curl_exec($ch);
$response_json = json_decode($response);
var_dump($response_json);
?>
{ "status": 200, "message": "success", "domain": { "name": "example.com", "status": "taken", "available": false } }
Get DNS zone.
object | The object reference to the product. Found in the /my/products/ call. |
---|
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
GET https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/my/products/[OBJECT]/dns/
Get all DNS records from a DNS zone.
object | The object reference to the product. Found in the /my/products/ call. |
---|
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
GET https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/my/products/[OBJECT]/dns/records/
Add a DNS record to a DNS zone.
object | The object reference to the product. Found in the /my/products/ call. |
---|
name | The name of the DNS record | string |
---|---|---|
data | The value of the DNS record | string |
type | The type of DNS record to add (A, MX, CNAME etc.) | string |
ttl | Optional. The amount of seconds for the TTL of the DNS record | integer |
priority | The priority of the DNS record, where applies | integer |
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
POST https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/my/products/[OBJECT]/dns/records/
{
"name": "www",
"type": "A",
"data": "127.0.0.1",
"priority": 0,
"ttl": 3600
}
Edit a record in a a DNS zone.
object | The object reference to the product. Found in the /my/products/ call. |
---|---|
record_id | The ID of the DNS record, from the /dns/records/ call. |
name | The name of the DNS record | string |
---|---|---|
data | The value of the DNS record | string |
type | The type of DNS record to add (A, MX, CNAME etc.) | string |
ttl | Optional. The amount of seconds for the TTL of the DNS record. | integer |
priority | The priority of the DNS record, where applies | integer |
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
PUT https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/my/products/[OBJECT]/dns/records/[RECORD_ID]
{
"name": "www",
"type": "A",
"data": "127.0.0.1",
"priority": 0,
"ttl": 3600
}
Delete a record from a DNS zone.
object | The object reference to the product. Found in the /my/products/ call. |
---|---|
record_id | The ID of the DNS record, from the /dns/records/ call. |
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
DELETE https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/my/products/[OBJECT]/dns/records/[RECORD_ID]
Force a reload of the DNS zone, increasing the serial.
object | The object reference to the product. Found in the /my/products/ call. |
---|
Every response has a 'status' and 'message' JSON component.
200 | Everything went as expected |
---|---|
400 | Something went wrong. See message field for more details. |
POST https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]/my/products/[OBJECT]/dns/reload/