API-dokumentasjon

API-endepunkt

Du kan finne HTTP-endepunktet på https://api.simply.com/2/ - prefiks dine forespørsler med dette.

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

Autentisering

Autentisering skjer med HTTP Basic Authentication.

Passord er API-nøkkelen for den spesifikke kontoen.

Brukernavn kan være hva som helst, fordi API-nøkkelen alene identifiserer kontoen.

Alternativt kan API-nøkkelen sendes som Bearer-token i Authorization-headeren:

Authorization: Bearer APIKEY

API-nøkler opprettes i Simply.com Kontrollpanelet under Konto, API-nøkler.

OpenApi-spesifikasjon / Dokumentasjon

Du kan finne den interaktive API-dokumentasjonen her: https://api.simply.com/2/doc/

Eller hent OpenAPI-spesifikasjonen som JSON: https://api.simply.com/2/doc.json

Begrensninger for antall forespørsler

API er underlagt hastighetsbegrensninger, kun for å forhindre misbruk.

Ved overskridelse svarer API med 429 og angir ventetiden i Retry-After.

Bibliotekimplementeringer

Følgende biblioteker er tilgjengelige for bruk.

ACME-implementeringer

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-implementeringer

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

ddns.simply.com (DynDNS2)

Rutere og DDNS-klienter som støtter DynDNS2-protokollen, kan bruke verten ddns.simply.com direkte.

Til skript og annen automatisering av DNS anbefaler vi REST API-et, som kan opprette, endre og slette DNS-poster.

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

Autentisering skjer med HTTP Basic Authentication, hvor passordet er API-nøkkelen for kontoen. Brukernavnet kan være hva som helst, f.eks. kontonavnet.

Utelates myip, brukes IP-adressen som forespørselen kommer fra. Oppdateringer må skje over HTTPS.

Recorden må finnes i DNS-sonen, før den kan oppdateres: en A-record for IPv4 og en AAAA-record for IPv6. Finnes den ikke, svares det med nohost, så opprett recorden i kontrollpanelet først.

Parameteren domain angir domenet. Den skal medsendes, når selve domenet oppdateres, f.eks. hostname=example.com&domain=example.com, og kan brukes, når domenet ikke kan utledes av hostname.

Svarene følger DynDNS2-protokollen, f.eks. good ved en oppdatering og nochg, når IP-adressen er uendret.

Adressen https://ddns.simply.com/myip returnerer den offentlige IP-adressen som forespørselen kommer fra, og krever ikke autentisering.

ddclient

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

Curl eksempel (Anbefalt)

Bruk følgende Curl-kommando for å sette home.example.com til den eksterne IP for den anmodende klient:

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

Du kan sette denne kommandoen til å kjøre i en crontab, på en lokal maskin, hvert 15. minutt eller deromkring.

Synology

På Synology kan du bruke følgende syntaks som Custom DDNS Provider

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

hostname skal deretter angis som det fullstendig kvalifiserte domenenavnet du ønsker å oppdatere, f.eks. home.example.com.

Home Assistant

Sensoren henter den offentlige IP-adressen hvert 5. minutt, og automasjonen oppdaterer kun DNS når adressen endrer seg, og når Home Assistant starter. API-nøkkelen lagres i 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

I UniFi OS må du sette opp en egendefinert dynamisk DNS-leverandør og skrive inn følgende streng i "Server"-feltet.

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

Simply.com API-dokumentasjon