API-dokumentaatio

API-päätepiste

Voit löytää HTTP-päätepisteen osoitteesta https://api.simply.com/2/ - lisää tämä etuliite pyyntöihisi.

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

Todennus

Tunnistautuminen tapahtuu HTTP Basic Authentication -menetelmällä.

Salasana on API-avain tietylle tilille.

Käyttäjätunnus voi olla mitä tahansa, sillä API-avain yksin tunnistaa tilin.

Vaihtoehtoisesti API-avain voidaan lähettää Bearer-tokenina Authorization-otsakkeessa:

Authorization: Bearer APIKEY

API-avaimet luodaan Simply.comin hallintapaneelissa Tili, API-avaimet.

OpenApi Spec / Dokumentaatio

Löydät interaktiivisen API-dokumentaation täältä: https://api.simply.com/2/doc/

Tai hae OpenAPI-määritys JSON-muodossa: https://api.simply.com/2/doc.json

Nopeusrajoitukset

API on alisteinen nopeusrajoituksille, vain väärinkäytön estämiseksi.

Kun ylitetään raja, API vastaa 429 ja ilmoittaa odotusajan Retry-After.

Simply.com AI Connector (MCP)

Yhdistä Claude, Cursor, Codex ja muut tekoälyavustajat Simply.com:iin MCP:n kautta. Muokkaa DNS-asetuksia, vaihda nimipalvelimia, etsi vapaita verkkotunnuksia, luo sähköpostitilejä ja tarkista lokitiedostoja vain kysymällä.

Lue lisää

Kirjastototeutukset

Seuraavat kirjastot ovat käytettävissä.

ACME-toteutukset

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)

Reitittimet ja DDNS-asiakkaat, jotka tukevat DynDNS2-protokollaa, voivat käyttää isäntää ddns.simply.com suoraan.

Skripteille ja muulle DNS-automaatiolle suosittelemme REST API:a, joka voi luoda, muokata ja poistaa DNS-tietueita.

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

Todennus tapahtuu HTTP Basic Authentication -menetelmällä, jossa salasana on tilin API-avain. Käyttäjänimi voi olla mitä tahansa, esimerkiksi tilin nimi.

Jos myip jätetään pois, käytetään sitä IP-osoitetta, josta pyyntö tulee. Päivitykset tulee tehdä HTTPS:n kautta.

Tietue täytyy löytyä DNS-alueelta, ennen kuin sitä voidaan päivittää: A-tietue IPv4:lle ja AAAA-tietue IPv6:lle. Jos sitä ei löydy, vastataan nohost, joten luo tietue hallintapaneelissa ensin.

Parametri domain määrittää verkkotunnuksen. Se on lähetettävä mukana, kun itse verkkotunnus päivitetään, esim. hostname=example.com&domain=example.com, ja sitä voidaan käyttää, kun verkkotunnusta ei voida päätellä hostname:sta.

Vastaukset noudattavat DynDNS2-protokollaa, esim. good päivityksessä ja nochg, kun IP-osoite on muuttumaton.

Osoite https://ddns.simply.com/myip palauttaa julkisen IP-osoitteen, josta pyyntö tulee, eikä vaadi todennusta.

ddclient

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

Curl-esimerkki (Suositus)

Käytä seuraavaa Curl-komentoa asettaaksesi home.example.com ulkoiseen IP-osoitteeseen pyytävälle asiakkaalle:

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

Voit asettaa tämän komennon ajettavaksi crontabissa paikallisella koneella 15 minuutin välein tai suunnilleen niin.

Synology

Synologyssa voit käyttää seuraavaa syntaksia Custom DDNS Providerina

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

hostname tulee sitten ilmoittaa täydellisenä kelvollisena verkkotunnuksena, jonka haluat päivittää, esim. home.example.com.

Home Assistant

Sensori hakee julkisen IP-osoitteen 5 minuutin välein, ja automaatio päivittää DNS:n vain, kun osoite muuttuu, ja kun Home Assistant käynnistyy. API-avain tallennetaan tiedostoon 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:ssa sinun tulee määrittää mukautettu dynaaminen DNS-palveluntarjoaja ja syöttää seuraava merkkijono "Palvelin"-kenttään.

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

Simply.com API-dokumentaatio