Simply.com is available in english

Simply.com API-dokumentaatio

Tämä asiakirja kuvaa Simply.com RESTful JSON API:ta.

API-päätepiste

Voit löytää HTTP-päätepisteen osoitteesta https://api.simply.com/2/ - esitä pyyntösi tämän kanssa.

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

Todennus

Tunnistautuminen tapahtuu HTTP Basic Authentication -menetelmällä.

Käyttäjätunnus on Simply.com-tilinumero (Sxxxxxx).

Salasana on API-avain tietylle tilille.

Sekä tilinumero että API-avain, jotka on liitetty Simply.com-tiliisi, löytyvät Simply.com-hallintapaneelista.

OpenApi Spec / Dokumentaatio

Löydät API:n OpenAPI-määrittelyn täältä: https://api.simply.com/2/openapi.json .

Harkitse Swagger UI -selaimen käyttöä täällä: https://generator.swagger.io/ .

Nopeusrajoitukset

API on alisteinen nopeusrajoituksille, vain väärinkäytön estämiseksi.

Voit nähdä rajan ja kulutuksen X-RateLimit-Limit ja X-RateLimit-Remaining otsikot.

Kirjastototeutukset

Esimerkit

Dynamic DNS-ohjeet

Päätepisteet /ddns/ ja /dyndns/ auttaa sinua helposti määrittämään DDNS:n verkkotunnukselle.

/dyndns/ emuloi tiukasti DynDns-protokollaa, kun taas /ddns/ yrittää antaa kuvailevampia vastauksia ja hyväksyy useampia argumentteja.

Curl-esimerkki (Suositus)

Käytä seuraavaa Curl-komentoa asettaaksesi home.example.com ulkoiseen IP-osoitteeseen pyytävälle asiakkaalle:

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

Voit asettaa tämän komennon ajettavaksi crontabissa paikallisella koneella 15 minuutin välein tai suunnilleen niin.

Synology

Synologyssa voit käyttää seuraavaa syntaksia Custom DDNS Providerina

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

hostname tulee sitten ilmoittaa täydellisenä kelvollisena verkkotunnuksena, jonka haluat päivittää, esim. 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:ssa sinun tulee määrittää mukautettu dynaaminen DNS-palveluntarjoaja ja syöttää seuraava merkkijono "Palvelin"-kenttään.

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