Simply.com is available in english

Simply.com API-dokumentation

Detta dokument beskriver Simply.com RESTful JSON API.

API-endpunkt

Du kan hitta HTTP-endpoint på https://api.simply.com/2/ - prefixera dina förfrågningar med detta.

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

Autentisering

Autentisering sker med HTTP Basic Authentication.

Användarnamn är Simply.com Kontonumret (Sxxxxxx).

Lösenord är API-nyckeln för det specifika kontot.

Både Kontonummer och API-nyckel tilldelad ditt Simply.com-konto kan hittas i ditt Simply.com Kontrollpanel.

OpenApi Spec / Dokumentation

Du kan hitta OpenAPI-specifikationen för API här: https://api.simply.com/2/openapi.json .

Överväg att använda Swagger UI-webbläsaren här: https://generator.swagger.io/ .

Gränser för hastighet

API är föremål för hastighetsbegränsningar, endast för att förhindra missbruk.

Du kan se gränsen och förbrukningen i X-RateLimit-Limit och X-RateLimit-Remaining rubriker.

Biblioteksimplementationer

Följande bibliotek är tillgängliga för användning.

ACME-implementeringar

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

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

Exempel

Dynamic DNS-hjälp

Slutpunkterna /ddns/ och /dyndns/ hjälper dig enkelt att ställa in DDNS på en domän.

/dyndns/ emulerar strikt DynDns-protokollet, medan /ddns/ försöker att ge mer beskrivande svar och accepterar fler argument.

Curl-exempel (Rekommenderas)

Använd följande Curl-kommando för att ställa in home.example.com till den externa IP:n för den begärande klienten:

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

Du kan ställa in det här kommandot att köras i en crontab, på en lokal maskin, var 15:e minut eller så.

Synology

På Synology kan du använda följande syntax som anpassad DDNS-leverantör

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

hostname ska därefter anges som det fullständigt kvalificerade domännamnet som du vill uppdatera, t.ex. 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

I UniFi OS ska du ställa in en anpassad dynamisk DNS-leverantör och ange följande sträng i "Server"-fältet.

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