See dokument kirjeldab Simply.com RESTful JSON API-d.
Saate leida HTTP lõpp-punkti aadressil https://api.simply.com/2/ - lisage see oma päringute ette.
Autentimine toimub HTTP Basic Authentication abil.
Parool on API-võti konkreetse konto jaoks.
kasutajanimi võib olla mis tahes, kuna API-võti üksinda tuvastab konto.
Alternatiivselt saab API-võtme saata Bearer-tokenina Authorization-päises:
Authorization: Bearer APIKEYAPI-võtmed luuakse Simply.com Kontrollpaneelis jaotises Konto, API-võtmed.
Saate leida interaktiivse API-dokumentatsiooni siit: https://api.simply.com/2/doc/
Või lae OpenAPI spetsifikatsiooni JSON-ina: https://api.simply.com/2/doc.json
API on allutatud kiiruspiirangutele, ainult kuritarvitamise vältimiseks.
Limiidi ületamisel vastab API koodiga 429 ja näitab ooteaega päises Retry-After.
Järgmised teegid on kasutamiseks saadaval.
| 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 |
| PHP | https://github.com/simplycom/api-php/ |
|---|
Ruuterid ja DDNS-kliendid, mis toetavad DynDNS2-protokolli, saavad kasutada hosti ddns.simply.com otse.
Skriptide ja muu DNS-i automatiseerimise jaoks soovitame REST API-d, mis suudab luua, muuta ja kustutada DNS-kirjeid.
https://ddns.simply.com/nic/update?hostname=home.example.com&domain=example.com&myip=1.2.3.4Autentimine toimub HTTP Basic Authentication abil, kus parool on konto API-võti. Kasutajanimi võib olla mis tahes, näiteks konto nimi.
Kui myip jäetakse välja, kasutatakse IP-aadressi, kust päring tuleb. Uuendused peavad toimuma HTTPS-i kaudu.
Kirje peab olema DNS-tsoonis, enne kui seda saab värskendada: A-kirje IPv4 jaoks ja AAAA-kirje IPv6 jaoks. Kui kirjet ei leita, vastatakse nohost-ga, siis loo kirje kõigepealt kontrollpaneelis.
Parameeter domain määrab domeeni. Seda tuleb kaasa saata, kui domeen ise uuendatakse, näiteks hostname=example.com&domain=example.com, ja seda saab kasutada, kui domeeni ei saa tuletada hostname põhjal.
Vastused järgivad DynDNS2-protokolli, näiteks good värskenduse korral ja nochg, kui IP-aadress on muutumata.
Aadress https://ddns.simply.com/myip tagastab avaliku IP-aadressi, kust päring tuleb, ja ei nõua autentimist.
protocol=dyndns2
ssl=yes
server=ddns.simply.com
login=ACCOUNTNAME
password=APIKEY
home.example.com
Kasutage järgmist käsku, et seada home.example.com taotleva kliendi välisele IP-aadressile:
curl -s -u "ACCOUNTNAME:APIKEY" "https://ddns.simply.com/nic/update?hostname=home.example.com"Saate selle käsu seadistada crontab-is kohalikus masinas käivituma iga 15 minuti järel või umbes nii.
Synologyl saate kasutada järgmist süntaksit kui Custom DDNS Provider
https://ddns.simply.com/nic/update?hostname=__HOSTNAME__&myip=__MYIP__
hostname tuleb seejärel määrata täielikult kvalifitseeritud domeeninimeks, mida soovite uuendada, nt. home.example.com.
Sensor hankib avaliku IP-aadressi iga 5 minuti järel ja automaatika värskendab DNS-i ainult siis, kui aadress muutub ja kui Home Assistant käivitub. API-võti salvestatakse secrets.yaml-i.
# 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_ddnsUniFi OS-is peate seadistama kohandatud dünaamilise DNS-i pakkuja ja sisestama järgmise stringi "Server" väljale.
ddns.simply.com/nic/update?hostname=%h&myip=%i
