Simply.com is available in english

Simply.com API skjölun

Þetta skjal lýsir Simply.com RESTful JSON API.

API endpoint

Þú getur fundið HTTP endpoint á https://api.simply.com/2/ - forskeyttu fyrirspurnir þínar með þessu.

Dæmi: https://api.simply.com/2/my/products/

Auðkenning

Auðkenning fer fram með HTTP Basic Authentication.

lykilorð er API-lykillinn fyrir tiltekna reikninginn.

Notandanafn má vera hvað sem er, þar sem API-lykillinn einungis auðkennir reikninginn.

Annars er hægt að senda API-lykilinn sem Bearer-token í Authorization-headerinu:

Authorization: Bearer APIKEY

API-lyklar eru búnir til í Simply.com stjórnborðinu undir Reikning, API-lyklar.

OpenApi Spec / Skjölun

Þú getur fundið gagnvirka API-skjölunina hér: https://api.simply.com/2/doc/

Eða hlaða niður OpenAPI-skilgreiningunni sem JSON: https://api.simply.com/2/doc.json

Hraðatakmarkanir

API er háð hraðatakmörkunum, eingöngu til að koma í veg fyrir misnotkun.

Við að fara yfir takmörk svarar API með 429 og tilgreinir biðtímann í Retry-After.

Simply.com AI Connector (MCP)

Tengdu Claude, Cursor, Codex og aðra AI-aðstoðarmenn við Simply.com í gegnum MCP. Breyttu DNS, skiptu um nafnþjóna, finndu laus lén, stofnaðu pósthólf og skoðaðu atvikaskrár, bara með því að spyrja.

Lesa meira

Bókasafnsútfærslur

Eftirfarandi bókasöfn eru tiltæk til notkunar.

ACME útfærslur

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)

Routerar og DDNS-klientar, sem styðja DynDNS2-protokollina, geta notað þjóninn ddns.simply.com beint.

Fyrir skriftur og aðra sjálfvirkni DNS mælum við með REST API-inu, sem getur búið til, breytt og eytt DNS-færslum.

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

Staðfesting fer fram með HTTP Basic Authentication, þar sem lykilorðið er API-lykillinn fyrir reikninginn. Notandanafn getur verið hvað sem er, t.d. reikningsnafn.

Ef myip er sleppt, er notað IP-vistfangið sem beiðnin kemur frá. Uppfærslur skulu gerast yfir HTTPS.

Recordið þarf að vera í DNS-svæðinu áður en hægt er að uppfæra það: ein A-record fyrir IPv4 og ein AAAA-record fyrir IPv6. Ef það er ekki til, svarar kerfið nohost, þannig að þú þarft að búa til recordið í stjórnborðinu fyrst.

Parameterinn domain tilgreinir lénið. Það skal senda með þegar sjálft lénið er uppfært, t.d. hostname=example.com&domain=example.com, og má nota þegar lénið er ekki hægt að draga af hostname.

Svörin fylgja DynDNS2-protokollinni, t.d. good við uppfærslu og nochg, þegar IP-vistfangið er óbreytt.

Vistfangið https://ddns.simply.com/myip skilar opinberri IP-tölu, sem beiðnin kemur frá, og krefst ekki auðkenningar.

ddclient

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

Curl dæmi (Mælt með)

Notaðu eftirfarandi Curl skipun til að setja home.example.com til ytri IP fyrir beiðnisklientinn:

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

Þú getur stillt þessa skipun til að keyra í crontab, á staðbundinni vél, á 15 mínútna fresti eða þar um bil.

Synology

Á Synology geturðu notað eftirfarandi setningafræði sem sérsniðinn DDNS-veitanda.

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

hostname skal síðan gefið upp sem fullgilt lénsheiti sem þú vilt uppfæra, t.d. home.example.com.

Home Assistant

Skynjarinn sækir opinbera IP-tölu á 5 mínútna fresti, og sjálfvirkni uppfærir aðeins DNS þegar IP-talan breytist og þegar Home Assistant ræsir. API-lykillinn er vistaður í 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 þarftu að setja upp sérsniðinn Dynamic DNS þjónustuaðila og slá inn eftirfarandi streng í "Server" reitinn.

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