API dokumentáció

API végpont

Az HTTP végpontot megtalálhatja itt https://api.simply.com/2/ - Adj előtagot a kérdéseidhez ezzel.

Példa: https://api.simply.com/2/my/products/

Hitelesítés

A hitelesítés HTTP Basic Authentication segítségével történik.

Jelszó az API-kulcs a konkrét fiókhoz.

Felhasználónév bármi lehet, mivel az API-kulcs egyedül azonosítja a fiókot.

Alternatív módon az API‑kulcs elküldhető Bearer‑tokenként az Authorization‑fejlécben:

Authorization: Bearer APIKEY

Az API-kulcsok a Simply.com vezérlőpultban hozhatók létre a Fiók, API‑kulcsok alatt.

OpenAPI Spec / Dokumentáció

Itt megtalálod az interaktív API-dokumentációt: https://api.simply.com/2/doc/

Vagy töltsd le az OpenAPI specifikációt JSON‑ként: https://api.simply.com/2/doc.json

Kéréskorlátok

Az API rate limitnek van kitéve, csak a visszaélés megelőzése érdekében.

Túllépés esetén az API 429-et ad vissza, és a várakozási időt a Retry-After-ben adja meg.

Könyvtár‑implementációk

A következő könyvtárak felhasználásra elérhetők.

ACME implementációk

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 megvalósítások

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

ddns.simply.com (DynDNS2)

Routerek és DDNS-kliensek, amelyek támogatják a DynDNS2 protokollt, közvetlenül használhatják a ddns.simply.com hostot.

A szkriptekhez és egyéb DNS-automatizáláshoz a REST API-t ajánljuk, amely képes létrehozni, módosítani és törölni a DNS-rekordokat.

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

Az azonosítás HTTP Basic Authentication segítségével történik, ahol a jelszó a fiók API-kulcsa. A felhasználónév lehet bármi, például a fiók neve.

Ha kihagyod a myip kódot, akkor a kérés érkezési IP-címe lesz használva. A frissítéseknek HTTPS-en kell történniük.

A rekordnak megtalálhatónak kell lennie a DNS-zónában, mielőtt frissíthető: egy A-rekord IPv4-hez és egy AAAA-rekord IPv6-hez. Ha nem található, akkor nohost a válasz, ezért először hozd létre a rekordot a vezérlőpulton.

A domain paraméter megadja a domaint. Ezt kell elküldeni, amikor magát a domaint frissítik, például hostname=example.com&domain=example.com, és használható, amikor a domaint nem lehet levezetni a hostname alapján.

A válaszok a DynDNS2-protokollt követik, pl. good egy frissítéskor és nochg, amikor az IP-cím változatlan.

Az https://ddns.simply.com/myip visszaadja a nyilvános IP-címet, ahonnan a kérés érkezik, és nem igényel hitelesítést.

ddclient

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

Curl példa (Ajánlott)

Használja a következő Curl parancsot a beállításhoz home.example.com a kérő kliens külső IP-címéhez:

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

Beállíthatja ezt a parancsot, hogy egy crontabban fusson, egy helyi gépen, körülbelül 15 percenként.

Synology

A Synology‑nél a következő szintaxist használhatja egyéni DDNS szolgáltatóként

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

hostname Ezután a teljesen kvalifikált domain nevet kell megadni, amelyet frissíteni szeretne, például. home.example.com.

Home Assistant

A szenzor 5 percenként lekéri a nyilvános IP-címet, és az automatizálás csak akkor frissíti a DNS-t, amikor a cím megváltozik, illetve amikor a Home Assistant elindul. Az API-kulcs a secrets.yaml-ban tárolódik.

# 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

Az UniFi OS‑ben be kell állítanod egy Custom Dynamic DNS szolgáltatót, és be kell írnod a következő karakterláncot a "Server" mezőbe.

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

Simply.com API dokumentáció