Simply.com is available in english
Switch language to english

Dokumentace API Simply.com

Tento dokument popisuje Simply.com RESTful JSON API.

Interaktivní dokumentace API
OpenAPI specifikace

Koncový bod API

HTTP endpoint můžete najít na https://api.simply.com/2/ - předponujte své požadavky tímto.

Příklad: https://api.simply.com/2/my/products/

Ověření

Ověření probíhá pomocí HTTP Basic Authentication.

Uživatelské jméno je Simply.com číslo účtu (Sxxxxxx).

Heslo je API klíč pro konkrétní účet.

API klíče se vytvářejí v Simply.com Kontrolním panelu pod Účet, API klíče.

Specifikace OpenApi / Dokumentace

Můžeš najít interaktivní dokumentaci API zde: https://api.simply.com/2/doc/

Nebo stáhněte specifikaci OpenAPI jako JSON: https://api.simply.com/2/doc.json

Limity sazeb

API je podléhá omezením rychlosti, pouze aby se zabránilo zneužití.

Můžete vidět limit a spotřebu v X-RateLimit-Limit a X-RateLimit-Remaining záhlaví.

Implementace knihovny

Následující knihovny jsou k dispozici k použití.

Implementace ACME

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

Implementace API

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

Příklady

Pomoc s dynamickým DNS

Koncové body /ddns/ a /dyndns/ pomůže vám snadno nastavit DDNS na doméně.

/dyndns/ emuluje přísně protokol DynDns, zatímco /ddns/ se snaží poskytnout více popisné odpovědi a přijímá více argumentů.

Příklad Curl (Doporučeno)

Použijte následující příkaz Curl k nastavení home.example.com na externí IP adresu žádajícího klienta: 

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

Tento příkaz můžete nastavit tak, aby se spouštěl v crontab na místním počítači každých 15 minut nebo tak nějak.

Synology

Na Synology můžete použít následující syntaxi jako vlastní poskytovatel DDNS.

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

hostname musí být poté uvedeno jako plně kvalifikovaný název domény, který chcete aktualizovat, např. 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

V UniFi OS musíte nastavit poskytovatele vlastní dynamické DNS a zadat následující řetězec do pole "Server".

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