Simply.com is available in english

Dokumentacja API Simply.com

Ten dokument opisuje RESTful JSON API Simply.com.

punkt końcowy API

Możesz znaleźć punkt końcowy HTTP na https://api.simply.com/2/ - poprzedź swoje zapytania tym.

Przykład: https://api.simply.com/2/my/products/

Uwierzytelnianie

Uwierzytelnianie odbywa się poprzez wysłanie klucza API dla konkretnego konta jako token Bearer w nagłówku Authorization:

Authorization: Bearer APIKEY

Klucze API są tworzone w panelu sterowania Simply.com w sekcji Konto, klucze API.

HTTP Basic Authentication z kluczem API jako hasłem nadal działa, ale jest przestarzałe. Integracje powinny przejść na token Bearer.

Specyfikacja OpenApi / Dokumentacja

Możesz znaleźć interaktywną dokumentację API tutaj: https://api.simply.com/2/doc/

Lub pobierz specyfikację OpenAPI jako JSON: https://api.simply.com/2/doc.json

API v3 Beta

Wersja 3 API jest w fazie beta. Punkty końcowe, pola i zachowanie mogą się nadal zmieniać bez uprzedzenia, dlatego integracje wymagające stabilności powinny nadal korzystać z wersji 2.

Endpoint: https://api.simply.com/3/

Możesz znaleźć interaktywną dokumentację API tutaj: https://api.simply.com/3/doc/

Lub pobierz specyfikację OpenAPI jako JSON: https://api.simply.com/3/doc.json

Limity szybkości

API podlega ograniczeniom szybkości, tylko w celu zapobiegania nadużyciom.

W przypadku przekroczenia API odpowiada kodem 429 i podaje czas oczekiwania w Retry-After.

Simply.com AI Connector (MCP)

Połącz Claude, Cursor, Codex i inne asystenty AI z Simply.com przez MCP. Edytuj DNS, zmień serwery nazw, znajdź wolne domeny, utwórz konta e-mail i sprawdzaj logi, po prostu pytając.

Przeczytaj więcej

Implementacje bibliotek

Następujące biblioteki są dostępne do użytku.

Implementacje ACME

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

ddns.simply.com (DynDNS2)

Routery i klienci DDNS, obsługujący protokół DynDNS2, mogą używać hosta ddns.simply.com bezpośrednio.

Do skryptów i innych automatyzacji DNS zalecamy REST API, które może tworzyć, modyfikować i usuwać rekordy DNS.

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

Uwierzytelnianie odbywa się przy użyciu HTTP Basic Authentication, gdzie hasło jest kluczem API konta. Nazwa użytkownika może być dowolna, np. nazwą konta.

Jeśli pominięto myip, używany jest adres IP, z którego pochodzi żądanie. Aktualizacje muszą odbywać się przez HTTPS.

Rekord musi być znaleziony w strefie DNS, zanim będzie można go zaktualizować: rekord A dla IPv4 i rekord AAAA dla IPv6. Jeśli go nie ma, zwracany jest nohost, więc najpierw utwórz rekord w panelu kontrolnym.

Parametr domain określa domenę. Należy go przesłać, gdy sama domena jest aktualizowana, np. hostname=example.com&domain=example.com, i może być użyty, gdy domena nie może być wywnioskowana z hostname.

Odpowiedzi są zgodne z protokołem DynDNS2, np. good przy aktualizacji i nochg, gdy adres IP nie uległ zmianie.

Adres https://ddns.simply.com/myip zwraca publiczny adres IP, z którego pochodzi żądanie, i nie wymaga uwierzytelnienia.

ddclient

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

Przykład Curl (Zalecane)

Użyj następującego polecenia Curl, aby ustawić home.example.com na zewnętrzny adres IP klienta wysyłającego żądanie:

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

Możesz ustawić tę komendę, aby działała w crontab na lokalnej maszynie co 15 minut lub coś koło tego.

Synology

Na Synology możesz użyć następującej składni jako niestandardowego dostawcy DDNS.

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

hostname należy następnie podać jako pełną kwalifikowaną nazwę domeny, którą chcesz zaktualizować, np. home.example.com.

Home Assistant

Czujnik pobiera publiczny adres IP co 5 minut, a automatyzacja aktualizuje DNS tylko wtedy, gdy adres się zmieni i gdy Home Assistant się uruchomi. Klucz API jest przechowywany w 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

W UniFi OS musisz skonfigurować niestandardowego dostawcę Dynamicznego DNS i wpisać następujący ciąg w polu "Serwer".

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