Dokumentacja API

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ę za pomocą HTTP Basic Authentication.

Hasło jest kluczem API dla konkretnego konta.

Nazwa użytkownika może być cokolwiek, ponieważ klucz API samodzielnie identyfikuje konto.

Alternatywnie klucz API może zostać przesłany jako token Bearer w nagłówku Authorization:

Authorization: Bearer APIKEY

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

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

Limity szybkości

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

Możesz zobaczyć limit i zużycie w X-RateLimit-Limit i X-RateLimit-Remaining nagłówki.

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

Implementacje API

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

Pomoc dynamicznego DNS

Punkty końcowe /ddns/ i /dyndns/ pomaga łatwo skonfigurować DDNS na domenie.

/dyndns/ emuluje ściśle protokół DynDns, podczas gdy /ddns/ próbuje udzielać bardziej opisowych odpowiedzi i akceptuje więcej argumentów.

Przykład Curl (Zalecane)

Użyj następującego polecenia Curl, aby ustawić home.example.com do zewnętrznego IP klienta żądającego:

curl -s -u "ACCOUNTNAME:APIKEY" "https://api.simply.com/2/ddns/?domain=example.com&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://api.simply.com/2/dyndns/?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

# 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

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

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

Dokumentacja API Simply.com