API documentation

This document describes the Simply.com RESTful JSON API.

Please note we reserve the right to block and ban users who abuse the API.

---

Authentication

The login information Nis given in the base URI and must be provided with each request.

Example: https://api.simply.com/1/[ACCOUNTNAME]/[APIKEY]

URI arguments

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.

---

Library

The following libraries are availiable for use.

PHP	https://github.com/simplycom/api-php

---

GET /my/products/ - List products

Returns a list of all products for the given account.

Response codes

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 /order/dnsservice/ - Order DNS Service

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.

Request arguments

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

Response codes

Every response has a 'status' and 'message' JSON component.

200	Everything went as expected
400	Something went wrong. See message field for more details.

Example response 1

{
    "status": 200,
    "message": "success",
    "payment": {
        "amount": 100
    }
}

---

GET /domaincheck/[domain] - Query domain availability status

Query the availability status of a domain.

URI arguments

domain	The name of the domain, in the format "example.com". IDNA format recommended.

Response codes

Every response has a 'status' and 'message' JSON component.

200	Everything went as expected
400	Something went wrong. See message field for more details.

Example response

{
    "status": 200,
    "message": "success",
    "domain": {
        "name": "example.com",
        "status": "taken",
        "available": false
    }
}

---

GET /my/products/[object]/dns - Get DNS zone

Get DNS zone.

URI arguments

object	The object reference to the product. Found in the /my/products/ call.

Response codes

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 /my/products/[object]/dns/records - Get records from DNS zone

Get all DNS records from a DNS zone.

URI arguments

object	The object reference to the product. Found in the /my/products/ call.

Response codes

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 /my/products/[object]/dns/records - Add record to DNS zone

Add a DNS record to a DNS zone.

URI arguments

object	The object reference to the product. Found in the /my/products/ call.

Request arguments

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

Response codes

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 /my/products/[object]/dns/records/[record_id] - Edit record in DNS zone

Edit a record in a a DNS zone.

URI arguments

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.

Request arguments

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

Response codes

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 /my/products/[object]/dns/records/[record_id] - Delete record from DNS zone

Delete a record from a DNS zone.

URI arguments

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.

Response codes

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 /my/products/[object]/dns/reload/ - Force a reload of the DNS zone

Force a reload of the DNS zone, increasing the serial.

URI arguments

object	The object reference to the product. Found in the /my/products/ call.

Response codes

Every response has a 'status' and 'message' JSON component.

200	Everything went as expected
400	Something went wrong. See message field for more details.