Simply.com is available in english

Simply.com API dokumentacija

Šis dokumentas aprašo Simply.com RESTful JSON API.

API galinis taškas

HTTP galinį tašką galite rasti adresu https://api.simply.com/2/ - pridėkite šį priešdėlį prie savo užklausų.

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

Autentifikavimas

Autentifikavimas vyksta naudojant HTTP Basic Authentication.

Vartotojo vardas yra Simply.com sąskaitos numeris (Sxxxxxx).

Slaptažodis yra API raktas konkrečiai paskyrai.

Tiek jūsų Simply.com paskyrai priskirtas sąskaitos numeris, tiek API raktas gali būti rasti jūsų Simply.com valdymo skydelyje.

OpenApi Spec / Dokumentacija

Galite rasti OpenAPI specifikaciją API čia: https://api.simply.com/2/openapi.json.

Apsvarstykite naudoti Swagger UI naršyklę čia: https://generator.swagger.io/.

Užklausų limitai

API yra taikomi užklausų dažnio apribojimai, tik siekiant užkirsti kelią piktnaudžiavimui.

Galite matyti ribą ir naudojimą X-RateLimit-Limit ir X-RateLimit-Remaining antraštės.

Bibliotekų įgyvendinimai

Šios bibliotekos yra prieinamos naudoti.

ACME įgyvendinimai

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 įgyvendinimai

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

Pavyzdžiai

Dynamic DNS pagalba

Pabaigos taškai /ddns/ ir /dyndns/ padeda lengvai nustatyti DDNS domenui.

/dyndns/ emuliuoja griežtai DynDns protokolą, tuo tarpu /ddns/ bando suteikti išsamesnius atsakymus ir priimti daugiau argumentų.

Curl pavyzdys (Rekomenduojama)

Naudokite šią Curl komandą, kad nustatytumėte home.example.com į išorinį IP adresą užklausą pateikiančiam klientui:

curl -s -u "ACCOUNTNAME:APIKEY" "https://api.simply.com/2/ddns/?domain=example.com&hostname=home.example.com"

Galite nustatyti šią komandą, kad ji būtų vykdoma crontab, vietiniame kompiuteryje, kas 15 minučių ar panašiai.

Synology

Synology įrenginyje galite naudoti šią sintaksę kaip Custom DDNS Provider

https://api.simply.com/2/dyndns/?hostname=__HOSTNAME__&myip=__MYIP__

hostname turi būti nurodytas kaip pilnai kvalifikuotas domeno vardas, kurį norite atnaujinti, pvz. home.example.com.

Home Assistant

# In configuration.yaml file
rest_command:
  simplycom_ddns:
    username: "ACCOUNTNAME"
    password: "APIKEY"
    url: "https://api.simply.com/2/ddns/?domain=example.com&hostname=home.example.com"
# Automation
alias: Simply.com DDNS
trigger:
- platform: time_pattern
  minutes: "0"
  seconds: "0"
action:
- service: rest_command.simplycom_ddns

Unifi

UniFi OS sistemoje turite nustatyti pasirinktinį dinaminį DNS teikėją ir įvesti šią eilutę į „Serverio“ lauką.

api.simply.com/2/dyndns/?hostname=%h&myip=%i