Simply.com is available in english
Switch language to english

Simply.com API-documentatie

Dit document beschrijft de Simply.com RESTful JSON API.

API v2

Interactieve API documentatie OpenAPI-specificatie

API v3 Beta

Interactieve API documentatie OpenAPI-specificatie

API-eindpunt

Je kunt het HTTP-endpoint vinden op https://api.simply.com/2/ - prefixeer je verzoeken hiermee.

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

Authenticatie

Authenticatie vindt plaats door de API-sleutel van de specifieke account als Bearer-token in de Authorization-header te versturen:

Authorization: Bearer APIKEY

API-sleutels worden aangemaakt in het Simply.com controlepaneel onder Account, API-sleutels.

HTTP Basic Authentication met de API-sleutel als wachtwoord werkt nog steeds, maar is verouderd. Integraties zouden moeten overschakelen naar het Bearer-token.

OpenApi-specificatie / Documentatie

Je kunt hier de interactieve API-documentatie vinden.: https://api.simply.com/2/doc/

Of download de OpenAPI-specificatie als JSON: https://api.simply.com/2/doc.json

API v3 Beta

Versie 3 van de API is in bèta. Endpoints, velden en gedrag kunnen nog zonder aankondiging veranderen, dus voor integraties die stabiliteit vereisen, is het raadzaam om versie 2 te blijven gebruiken.

Endpoint: https://api.simply.com/3/

Je kunt hier de interactieve API-documentatie vinden.: https://api.simply.com/3/doc/

Of download de OpenAPI-specificatie als JSON: https://api.simply.com/3/doc.json

Limieten voor het aantal aanvragen per tijdseenheid.

API is onderworpen aan snelheidslimieten, alleen om misbruik te voorkomen.

Bij overschrijding antwoordt de API met 429 en geeft de wachttijd aan in Retry-After.

Simply.com AI Connector (MCP)

Verbind Claude, Cursor, Codex en andere AI-assistenten met Simply.com via MCP. Pas DNS aan, wijzig nameservers, zoek beschikbare domeinen, maak e-mailaccounts aan en controleer logbestanden, gewoon door het te vragen.

Lees meer

Bibliotheekimplementaties

De volgende bibliotheken zijn beschikbaar voor gebruik.

ACME-implementaties

acme.sh https://github.com/acmesh-official/acme.sh/
Posh-ACME https://github.com/rmbolger/Posh-ACME/
cert-manager service https://github.com/RunnerM/simply-dns-webhook/
Certbot plugin https://github.com/JohNan/certbot-dns-simply/
Webhook provider for ExternalDNS https://github.com/uozalp/external-dns-simply-webhook

ddns.simply.com (DynDNS2)

Routers en DDNS-clients die het DynDNS2-protocol ondersteunen, kunnen de host ddns.simply.com direct gebruiken.

Voor scripts en andere automatisering van DNS raden we de REST API aan, die DNS-records kan aanmaken, wijzigen en verwijderen.

https://ddns.simply.com/nic/update?hostname=home.example.com&domain=example.com&myip=1.2.3.4

Authenticatie gebeurt met HTTP Basic Authentication, waarbij het wachtwoord de API-sleutel voor het account is. De gebruikersnaam kan alles zijn, bijv. de accountnaam.

Wordt myip weggelaten, wordt het IP-adres gebruikt vanwaar het verzoek komt. Updates moeten via HTTPS gebeuren.

De record moet gevonden worden in de DNS-zone, voordat deze kan worden bijgewerkt: een A-record voor IPv4 en een AAAA-record voor IPv6. Als deze niet bestaat, wordt nohost geantwoord, dan maak de record eerst aan in het controlepaneel.

De parameter domain geeft het domein aan. Deze moet worden meegestuurd wanneer het domein zelf wordt bijgewerkt, bijv. hostname=example.com&domain=example.com, en kan worden gebruikt wanneer het domein niet kan worden afgeleid van hostname.

De antwoorden volgen het DynDNS2-protocol, bijvoorbeeld good bij een update en nochg, wanneer het IP-adres ongewijzigd is.

Het adres https://ddns.simply.com/myip retourneert het openbare IP-adres, vanwaar het verzoek komt, en vereist geen authenticatie.

ddclient

protocol=dyndns2
ssl=yes
server=ddns.simply.com
login=ACCOUNTNAME
password=APIKEY
home.example.com

Curl voorbeeld (Aanbevolen)

Gebruik de volgende Curl-opdracht om in te stellen home.example.com naar het externe IP-adres van de verzoekende client: 

curl -s -u "ACCOUNTNAME:APIKEY" "https://ddns.simply.com/nic/update?hostname=home.example.com"

U kunt deze opdracht instellen om elke 15 minuten of zoiets te draaien in een crontab, op een lokale machine.

Synology

Op Synology kun je de volgende syntaxis gebruiken als Custom DDNS Provider

https://ddns.simply.com/nic/update?hostname=__HOSTNAME__&myip=__MYIP__

hostname moet vervolgens worden opgegeven als de volledig gekwalificeerde domeinnaam die u wilt bijwerken, bijv. home.example.com.

Home Assistant

De sensor haalt elke 5 minuten het openbare IP-adres op, en de automatisering werkt DNS alleen bij wanneer het adres verandert, en wanneer Home Assistant start. De API-sleutel wordt opgeslagen in secrets.yaml.

# configuration.yaml
sensor:
  - platform: rest
    name: Public IP
    resource: https://ddns.simply.com/myip
    value_template: "{{ value | trim }}"
    scan_interval: 300

rest_command:
  simplycom_ddns:
    url: "https://ddns.simply.com/nic/update?hostname=home.example.com"
    username: "ACCOUNTNAME"
    password: !secret simply_api_key
# secrets.yaml
simply_api_key: "APIKEY"
# Automation
alias: Simply.com DDNS
triggers:
  - trigger: state
    entity_id: sensor.public_ip
  - trigger: homeassistant
    event: start
actions:
  - action: rest_command.simplycom_ddns

Unifi

In UniFi OS moet je een Aangepaste Dynamische DNS-provider instellen en de volgende string invoeren in het "Server" veld.

ddns.simply.com/nic/update?hostname=%h&myip=%i