Simply.com is available in english

Simply.com API-Dokumentation

Dieses Dokument beschreibt das Simply.com RESTful JSON API.

API-Endpunkt

Sie können den HTTP-Endpunkt unter finden https://api.simply.com/2/ - präfixen Sie Ihre Anfragen damit.

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

Authentifizierung

Die Authentifizierung erfolgt mit HTTP Basic Authentication.

Benutzername ist Simply.com Kontonummer (Sxxxxxx).

Passwort ist der API-Schlüssel für das spezifische Konto.

Sowohl die Kontonummer als auch der API-Schlüssel, die Ihrem Simply.com-Konto zugewiesen sind, finden Sie in Ihrem Simply.com-Kontrollpanel.

OpenApi-Spezifikation / Dokumentation

Sie können die OpenAPI-Spezifikation für das API hier finden.: https://api.simply.com/2/openapi.json .

Erwägen Sie, den Swagger UI-Browser hier zu verwenden.: https://generator.swagger.io/ .

Ratenbegrenzungen

API unterliegt Ratenbeschränkungen, nur um Missbrauch zu verhindern.

Sie können das Limit und den Verbrauch in % sehen. X-RateLimit-Limit und X-RateLimit-Remaining Kopfzeilen.

Bibliotheksimplementierungen

Die folgenden Bibliotheken stehen zur Nutzung zur Verfügung.

ACME-Implementierungen

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

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

Beispiele

Dynamic DNS-Hilfe

Die Endpunkte /ddns/ und /dyndns/ hilft Ihnen, DDNS einfach auf einer Domain einzurichten.

/dyndns/ emuliert streng das DynDns-Protokoll, während /ddns/ versucht, ausführlichere Antworten zu geben und akzeptiert mehr Argumente.

Curl-Beispiel (Empfohlen)

Verwenden Sie den folgenden Curl-Befehl, um zu setzen home.example.com zur externen IP des anfragenden Clients:

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

Sie können diesen Befehl in einer Crontab auf einem lokalen Rechner alle 15 Minuten oder so ausführen lassen.

Synology

Auf Synology können Sie die folgende Syntax als benutzerdefinierten DDNS-Anbieter verwenden

https://api.simply.com/2/dyndns/?hostname=__HOSTNAME__&myip=__MYIP__

hostname soll dann als der vollständig qualifizierte Domainname angegeben werden, den Sie aktualisieren möchten, z. B. 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 müssen Sie einen benutzerdefinierten dynamischen DNS-Anbieter einrichten und den folgenden String in das "Server"-Feld eingeben.

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