API-documentatie

API-eindpunt

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

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

Authenticatie

Authenticatie gebeurt met HTTP Basic Authentication.

Wachtwoord is de API-sleutel voor het specifieke account.

Gebruikersnaam kan alles zijn, omdat de API-sleutel alleen het account identificeert.

Als alternatief kan de API‑sleutel worden verzonden als Bearer‑token in de Authorization‑header:

Authorization: Bearer APIKEY

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

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

Limieten voor het aantal aanvragen per tijdseenheid.

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

Domain check is beperkt per account. Bij overschrijding geeft de API antwoord met 429 en geeft de wachttijd aan in Retry-After.

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

API-implementaties

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

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 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

# In configuration.yaml file
rest_command:
  simplycom_ddns:
    url: "https://ddns.simply.com/nic/update?hostname=home.example.com"
    username: "ACCOUNTNAME"
    password: "APIKEY"

# Automation
alias: Simply.com DDNS
trigger:
- platform: time_pattern
  minutes: "0"
  seconds: "0"
action:
- service: 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

Simply.com API-documentatie