Simply.com API documentation

This document describes the Simply.com RESTful JSON API.

Note: The (current version 2) version of the API is very basic, we are working on a version 3, which is more modern.

API endpoint

You can find the HTTP endpoint on https://api.simply.com/2/, prefix your requests with this.

Example: https://api.simply.com/2/my/products/

Authentication

Authentication happens with HTTP Basic Authentication.

Username is the account-name and password is the API-KEY for the specific account

The API Key assigned to your Simply.com account can be found in your Simply.com Controlpanel.

OpenApi Spec

You can find the OpenAPI spec for the API here: https://api.simply.com/2/openapi/.

Consider using the Swagger UI browser here: https://generator.swagger.io/.

Library implementations

The following libraries are availiable for use.

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

Endpoints

GET /my/products/ - List products

Returns a list of all products for the given account.

GET /my/invoices/ - List invoices

Returns a list of all invoices for the given account.

POST /ddns/ - DDNS helper

This endpoint helps you easily set up DDNS on a domain on a given account.

Curl example

Use the following curl command to set home.example.com to the external IP of the requesting client:

curl -s -u "ACCOUNTNAME:APIKEY" -X POST "https://api.simply.com/2/ddns/?domain=example.com&hostname=home"

You can set this command to run in a crontab, on a local machine, every 15 minutes or so.

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.

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.

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

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

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.

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.

GET /my/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.

Example response

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

POST /my/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

Example response 1

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