API dokumentācija

API galapunkts

Jūs varat atrast HTTP galapunktu vietnē https://api.simply.com/2/ - prefiksējiet savus pieprasījumus ar šo.

Piemērs: https://api.simply.com/2/my/products/

Autentifikācija

Autentifikācija notiek, izmantojot HTTP Basic Authentication.

Parole ir API atslēga konkrētajam kontam.

lietotājvārds var būt jebkas, jo API atslēga tikai identificē kontu.

Alternatīvi API atslēgu var nosūtīt kā Bearer-token Authorization galvenē:

Authorization: Bearer APIKEY

API atslēgas tiek izveidotas Simply.com vadības panelī sadaļā Konta, API atslēgas.

OpenApi Spec / Dokumentācija

Jūs varat atrast interaktīvo API dokumentāciju šeit: https://api.simply.com/2/doc/

Vai lejupielādējiet OpenAPI specifikāciju JSON formātā: https://api.simply.com/2/doc.json

Ātruma ierobežojumi

API ir pakļauts ātruma ierobežojumiem, tikai lai novērstu ļaunprātīgu izmantošanu.

Pārsniedzot limitu, API atbild ar 429 un norāda gaidīšanas laiku Retry-After.

Simply.com AI Connector (MCP)

Savienojiet Claude, Cursor, Codex un citus AI asistentus ar Simply.com, izmantojot MCP. Labojiet DNS, mainiet nameserverus, atrodiet brīvus domēnus, izveidojiet e-pasta kontus un pārbaudiet žurnālfailus, vienkārši pajautājot.

Lasīt vairāk

Bibliotēku ieviešana

Šīs bibliotēkas ir pieejamas lietošanai.

ACME ieviešanas

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)

Maršrutētāji un DDNS klienti, kas atbalsta DynDNS2 protokolu, var tieši izmantot resursdatoru ddns.simply.com.

Skriptiem un citai DNS automatizācijai mēs iesakām REST API, kas var izveidot, mainīt un dzēst DNS ierakstus.

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

Autentifikācija notiek ar HTTP Basic Authentication, kur parole ir konta API atslēga. Lietotājvārds var būt jebkas, piemēram, konta nosaukums.

Ja izslēgts myip, tiek izmantota IP adrese, no kuras nāk pieprasījums. Atjauninājumus jāveic, izmantojot HTTPS.

Ieraksts jāatrod DNS zonā, pirms tas var tikt atjaunināts: A-record IPv4 un AAAA-record IPv6. Ja tas nepastāv, tiek atgriezts nohost, tāpēc vispirms izveidojiet ierakstu vadības panelī.

Parametrs domain norāda domēnu. To jānosūta, kad pats domēns tiek atjaunināts, piemēram hostname=example.com&domain=example.com, un var izmantot, ja domēnu nevar izsecināt no hostname.

Atbildes atbilst DynDNS2 protokolam, piemēram, good atjauninājuma gadījumā un nochg, kad IP-adrese nav mainīta.

Adrese https://ddns.simply.com/myip atgriež publisko IP adresi, no kuras nāk pieprasījums, un neprasa autentifikāciju.

ddclient

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

Curl piemērs (Rekomendēts)

Izmantojiet šo Curl komandu, lai iestatītu home.example.com uz klienta, kas veic pieprasījumu, ārējo IP adresi:

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

Jūs varat iestatīt šo komandu, lai tā tiktu palaista crontab, uz vietējā datora, ik pēc 15 minūtēm vai apmēram tā.

Synology

Synology ierīcē varat izmantot šādu sintaksi kā pielāgotu DDNS pakalpojumu sniedzēju

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

hostname pēc tam jānorāda kā pilnībā kvalificēts domēna vārds, kuru vēlaties atjaunināt, piem. home.example.com.

Home Assistant

Sensors ik pēc 5 minūtēm izgūst publisko IP adresi, un automatizācija atjaunina DNS tikai tad, kad adrese mainās, un kad Home Assistant tiek startēts. API atslēga tiek saglabāta failā 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 jums ir jāiestata pielāgots dinamiskais DNS nodrošinātājs un jāievada šāda virkne "Server" laukā.

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

Simply.com API dokumentācija