Simply.com is available in english

Simply.com API dokumentācija

Šis dokuments apraksta Simply.com RESTful JSON API.

API galapunkts

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

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

Autentifikācija

Autentifikācija notiek, izmantojot HTTP Basic Authentication.

lietotājvārds ir Simply.com konta numurs (Sxxxxxx).

Parole ir API atslēga konkrētajam kontam.

Gan konta numuru, gan API atslēgu, kas piešķirta jūsu Simply.com kontam, var atrast jūsu Simply.com vadības panelī.

OpenApi Spec / Dokumentācija

Jūs varat atrast OpenAPI specifikāciju API šeit: https://api.simply.com/2/openapi.json .

Apsveriet izmantot Swagger UI pārlūkprogrammu šeit: https://generator.swagger.io/ .

Ātruma ierobežojumi

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

Jūs varat redzēt limitu un patēriņu programmā X-RateLimit-Limit un X-RateLimit-Remaining galvenes.

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

API ieviešanas

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

Piemēri

Dynamic DNS palīgs

Galapunkti /ddns/ un /dyndns/ palīdz viegli iestatīt DDNS domēnam.

/dyndns/ emulē stingri DynDns protokolu, kamēr /ddns/ mēģina sniegt aprakstošākas atbildes un pieņem vairākus argumentus.

Curl piemērs (Rekomendēts)

Izmantojiet šo Curl komandu, lai iestatītu home.example.com uz ārējo IP pieprasītāja klientam:

curl -s -u "ACCOUNTNAME:APIKEY" "https://api.simply.com/2/ddns/?domain=example.com&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://api.simply.com/2/dyndns/?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

# 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 jums ir jāiestata pielāgots dinamiskais DNS nodrošinātājs un jāievada šāda virkne "Server" laukā.

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