API dokumentácia

API koncový bod

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

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

Autentifikácia

Autentifikácia prebieha pomocou HTTP Basic Authentication.

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

Používateľské meno môže byť čokoľvek, pretože API kľúč sám identifikuje účet.

Alternatívne môže byť API kľúč odoslaný ako Bearer-token v hlavičke Authorization:

Authorization: Bearer APIKEY

API-kľúče sa vytvoria v ovládacom paneli Simply.com v časti Účet, API-kľúče.

OpenApi špecifikácia / Dokumentácia

Môžete nájsť interaktívnu dokumentáciu API tu: https://api.simply.com/2/doc/

Alebo stiahnite špecifikáciu OpenAPI vo formáte JSON: https://api.simply.com/2/doc.json

Limity rýchlosti

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

Pri prekročení API odpovedá s 429 a uvádza čas čakania v Retry-After.

Simply.com AI Connector (MCP)

Pripojte Claude, Cursor, Codex a ďalších AI asistentov k Simply.com cez MCP. Opravte DNS, zmeňte nameservery, nájdite voľné domény, vytvorte e-mailové kontá a skontrolujte log súbory – stačí sa len opýtať.

Čítaj viac

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

ddns.simply.com (DynDNS2)

Routery a DDNS klienti, ktoré podporujú protokol DynDNS2, môžu použiť hostiteľa ddns.simply.com priamo.

Pre skripty a ďalšiu automatizáciu DNS odporúčame REST API, ktoré dokáže vytvárať, meniť a mazať DNS záznamy.

https://ddns.simply.com/nic/update?hostname=home.example.com&domain=example.com&myip=1.2.3.4

Autentifikácia prebieha pomocou HTTP Basic Authentication, kde heslo je API kľúč pre účet. Používateľské meno môže byť čokoľvek, napríklad názov účtu.

Ak je myip vynechaný, použije sa IP adresa, z ktorej požiadavka prichádza. Aktualizácie musia prebiehať cez HTTPS.

Záznam musí byť v DNS zóne, aby ho bolo možné aktualizovať: A-record pre IPv4 a AAAA-record pre IPv6. Ak neexistuje, odpovie sa nohost, takže najprv vytvorte záznam v ovládacom paneli.

Parameter domain určuje doménu. Musí byť odoslaný, keď sa aktualizuje samotná doména, napríklad hostname=example.com&domain=example.com, a môže sa použiť, keď doménu nie je možné odvodiť z hostname.

Odpovede dodržiavajú protokol DynDNS2, napr. good pri aktualizácii a nochg, keď je IP adresa nezmenená.

Adresa https://ddns.simply.com/myip vracia verejnú IP adresu, z ktorej požiadavka pochádza, a nevyžaduje autentifikáciu.

ddclient

protocol=dyndns2
ssl=yes
server=ddns.simply.com
login=ACCOUNTNAME
password=APIKEY
home.example.com

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://ddns.simply.com/nic/update?hostname=home.example.com"

Tento 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://ddns.simply.com/nic/update?hostname=__HOSTNAME__&myip=__MYIP__

hostname musí sa následne zadať ako úplne kvalifikovaný názov domény, ktorý chcete aktualizovať, napr. home.example.com.

Home Assistant

Senzor získava verejnú IP adresu každých 5 minút a automatizácia aktualizuje DNS len keď sa adresa zmení a keď sa spustí Home Assistant. API kľúč sa ukladá do secrets.yaml.

# configuration.yaml
sensor:
  - platform: rest
    name: Public IP
    resource: https://ddns.simply.com/myip
    value_template: "{{ value | trim }}"
    scan_interval: 300

rest_command:
  simplycom_ddns:
    url: "https://ddns.simply.com/nic/update?hostname=home.example.com"
    username: "ACCOUNTNAME"
    password: !secret simply_api_key

# secrets.yaml
simply_api_key: "APIKEY"

# Automation
alias: Simply.com DDNS
triggers:
  - trigger: state
    entity_id: sensor.public_ip
  - trigger: homeassistant
    event: start
actions:
  - action: 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".

ddns.simply.com/nic/update?hostname=%h&myip=%i

Simply.com API dokumentácia