Simply.com is available in english

Simply.com API skjölun

Þessi 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.

Notandanafn er Simply.com Reikningsnúmerið (Sxxxxxx).

lykilorð er API-lykillinn fyrir tiltekna reikninginn.

Bæði reikningsnúmer og API-lykill úthlutað Simply.com reikningnum þínum er að finna í Simply.com stjórnborðinu þínu.

OpenApi Spec / Skjölun

Þú getur fundið OpenAPI forskriftina fyrir API hér: https://api.simply.com/2/openapi.json .

Hugleiddu að nota Swagger UI vafrann hér: https://generator.swagger.io/ .

Hraðatakmarkanir

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

Þú getur séð mörkin og notkunina í X-RateLimit-Limit og X-RateLimit-Remaining fyrirsagnir.

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

API útfærslur

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

Dæmi

Dynamic DNS hjálp

Endapunktarnir /ddns/ og /dyndns/ hjálpar þér auðveldlega að setja upp DDNS á léni.

/dyndns/ hermir stranglega DynDns samskiptaregluna, meðan /ddns/ er að reyna að gefa lýsandi svör og samþykkja fleiri rök.

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://api.simply.com/2/ddns/?domain=example.com&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 veitandi.

https://api.simply.com/2/dyndns/?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

# 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 þarftu að setja upp sérsniðinn Dynamic DNS þjónustuaðila og slá inn eftirfarandi streng í "Server" reitinn.

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