Simply.com is available in english

Simply.com API dokumentácia

Tento dokument popisuje Simply.com RESTful JSON API.

API koncový bod

HTTP koncový bod nájdete na https://api.simply.com/2/ - predpon svoje požiadavky týmto.

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

Autentifikácia

Autentifikácia prebieha pomocou HTTP Basic Authentication.

Používateľské meno je Simply.com Číslo účtu (Sxxxxxx).

Heslo je API kľúč pre konkrétny účet.

Číslo účtu aj API kľúč pridelené k vášmu účtu Simply.com nájdete vo vašom ovládacom paneli Simply.com.

OpenApi špecifikácia / Dokumentácia

OpenAPI špecifikáciu pre API nájdete tu: https://api.simply.com/2/openapi.json .

Zvážte použitie prehliadača Swagger UI tu: https://generator.swagger.io/ .

Limity rýchlosti

API je predmetom obmedzení rýchlosti, len aby sa zabránilo zneužitiu.

Môžete vidieť limit a spotrebu v X-RateLimit-Limit a X-RateLimit-Remaining hlavičky.

Implementácie knižníc

Nasledujúce knižnice sú k dispozícii na použitie.

Implementácie 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

Implementácie API

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

Príklady

Pomoc s dynamickým DNS

Koncové body /ddns/ a /dyndns/ pomôže vám jednoducho nastaviť DDNS na doméne.

/dyndns/ emuluje prísne protokol DynDns, zatiaľ čo /ddns/ sa snaží poskytnúť viac opisných odpovedí a akceptuje viac argumentov.

Príklad Curl (Odporúčané)

Použite nasledujúci príkaz Curl na nastavenie home.example.com na externú IP adresu žiadajúceho klienta:

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

Túto príkaz môžete nastaviť na spustenie v crontab na miestnom počítači každých 15 minút alebo tak nejako.

Synology

Na Synology môžete použiť nasledujúcu syntax ako vlastného poskytovateľa DDNS.

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

hostname musí být poté zadáno 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 nastaviť vlastného poskytovateľa dynamického DNS a zadať nasledujúci reťazec do poľa "Server".

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