API dokumentacija

API galinis taškas

HTTP galinį tašką galite rasti adresu https://api.simply.com/2/ - pridėkite šį priešdėlį prie savo užklausų.

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

Autentifikavimas

Autentifikavimas vyksta naudojant HTTP Basic Authentication.

Slaptažodis yra API raktas konkrečiai paskyrai.

Vartotojo vardas gali būti bet kas, nes API raktas vien tik identifikuoja paskyrą.

Alternatyviai API raktas gali būti siunčiamas kaip Bearer tokenas Authorization antraštėje:

Authorization: Bearer APIKEY

API raktai kuriami Simply.com valdymo skydelyje skiltyje Paskyra, API raktai.

OpenApi Spec / Dokumentacija

Čia galite rasti interaktyvią API dokumentaciją: https://api.simply.com/2/doc/

Arba atsisiųskite OpenAPI specifikaciją JSON formatu: https://api.simply.com/2/doc.json

Užklausų limitai

API yra taikomi užklausų dažnio apribojimai, tik siekiant užkirsti kelią piktnaudžiavimui.

Viršijus limitą, API atsako 429 ir nurodo laukimo laiką Retry-After.

Bibliotekų įgyvendinimai

Šios bibliotekos yra prieinamos naudoti.

ACME įgyvendinimai

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 įgyvendinimai

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

ddns.simply.com (DynDNS2)

Maršrutizatoriai ir DDNS-klientai, kurie palaiko DynDNS2 protokolą, gali tiesiogiai naudoti serverį ddns.simply.com.

Skriptams ir kitai DNS automatizacijai rekomenduojame REST API, kuris gali kurti, keisti ir ištrinti DNS įrašus.

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

Autentifikavimas vyksta naudojant HTTP Basic Authentication, kur slaptažodis yra API raktas paskyrai. Naudotojo vardas gali būti bet koks, pvz., paskyros pavadinimas.

Jei praleidžiamas myip, naudojamas IP adresas, iš kurio ateina užklausa. Atnaujinimai turi būti atliekami per HTTPS.

Įrašas turi būti rastas DNS zonoje, prieš jį atnaujinant: A įrašas IPv4 ir AAAA įrašas IPv6. Jei jo nėra, grąžinama nohost, todėl pirmiausia sukurkite įrašą valdymo skydelyje.

Parametras domain nurodo domeną. Jis turi būti siunčiamas kartu, kai pats domenas atnaujinamas, pvz. hostname=example.com&domain=example.com, ir gali būti naudojamas, kai domenas negali būti išvestas iš hostname.

Atsakymai atitinka DynDNS2 protokolą, pvz. good atnaujinimo metu ir nochg, kai IP adresas nepasikeitė.

Adresas https://ddns.simply.com/myip grąžina viešąjį IP adresą, iš kurio ateina užklausa, ir nereikalauja autentifikacijos.

ddclient

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

Curl pavyzdys (Rekomenduojama)

Naudokite šią Curl komandą, kad nustatytumėte home.example.com į išorinį IP adresą užklausą pateikiančiam klientui:

curl -s -u "ACCOUNTNAME:APIKEY" "https://ddns.simply.com/nic/update?hostname=home.example.com"

Galite nustatyti šią komandą, kad ji būtų vykdoma crontab, vietiniame kompiuteryje, kas 15 minučių ar panašiai.

Synology

Synology įrenginyje galite naudoti šią sintaksę kaip Custom DDNS Provider

https://ddns.simply.com/nic/update?hostname=__HOSTNAME__&myip=__MYIP__

hostname turi būti nurodytas kaip pilnai kvalifikuotas domeno vardas, kurį norite atnaujinti, pvz. home.example.com.

Home Assistant

Jutiklis kas 5 minutes gauna viešąjį IP adresą, ir automatika atnaujina DNS tik tada, kai adresas pasikeičia, ir kai Home Assistant paleidžiamas. API raktas saugomas faile 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

UniFi OS sistemoje turite nustatyti pasirinktinį dinaminį DNS teikėją ir įvesti šią eilutę į lauką „Server“.

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

Simply.com API dokumentacija