Simply.com API-documentatie

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 gebeurt met HTTP Basic Authentication.

Gebruikersnaam is Simply.com Rekeningnummer (Sxxxxxx).

Wachtwoord is de API-sleutel voor het specifieke account.

Zowel het rekeningnummer als de API-sleutel die aan je Simply.com-account zijn toegewezen, zijn te vinden in je Simply.com-controlepaneel.

Je kunt de OpenAPI-specificatie voor de API hier vinden.: https://api.simply.com/2/openapi.json.

Overweeg om de Swagger UI-browser hier te gebruiken: https://generator.swagger.io/.

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

U kunt de limiet en het verbruik zien in X-RateLimit-Limit en X-RateLimit-Remaining headers.

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/

De eindpunten /ddns/ en /dyndns/ helpt je eenvoudig om DDNS op een domein in te stellen.

/dyndns/ emuleert strikt het DynDns-protocol, terwijl /ddns/ probeert meer beschrijvende antwoorden te geven en accepteert meer argumenten.

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://api.simply.com/2/ddns/?domain=example.com&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://api.simply.com/2/dyndns/?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:
    username: "ACCOUNTNAME"
    password: "APIKEY"
    url: "https://api.simply.com/2/ddns/?domain=example.com&hostname=home.example.com"

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

api.simply.com/2/dyndns/?hostname=%h&myip=%i