Simply.com is available in english

Simply.com API belgeleri

Bu belge Simply.com RESTful JSON API'yi açıklar.

API uç noktası

HTTP uç noktasını bulabilirsiniz https://api.simply.com/2/ - sorgularınızı bununla ön ekleyin.

Örnek: https://api.simply.com/2/my/products/

Kimlik doğrulama

Kimlik doğrulama HTTP Basic Authentication ile yapılır.

Kullanıcı adı Simply.com hesap numarasıdır (Sxxxxxx).

Şifre belirli hesabın API anahtarıdır.

Hem hesap numarası hem de API anahtarı, Simply.com hesabınıza atanmış, Simply.com kontrol panelinizde bulunabilir.

OpenApi Spec / Dokümantasyon

OpenAPI spesifikasyonunu API için burada bulabilirsiniz: https://api.simply.com/2/openapi.json .

Swagger UI tarayıcısını burada kullanmayı düşünün: https://generator.swagger.io/ .

İstek sınırları

API rate limitlerine tabidir, yalnızca kötüye kullanımı önlemek için.

Sınırı ve kullanımı içinde görebilirsiniz X-RateLimit-Limit ve X-RateLimit-Remaining başlıklar.

Kütüphane implementasyonları

Aşağıdaki kütüphaneler kullanılabilir.

ACME uygulamaları

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 uygulamaları

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

Örnekler

Dynamic DNS yardımcısı

Uç noktalar /ddns/ ve /dyndns/ DDNS'yi bir alan adına kurmanıza kolayca yardımcı olur.

/dyndns/ DynDns protokolünü katı bir şekilde taklit eder, iken /ddns/ daha açıklayıcı cevaplar vermeye çalışıyor ve daha fazla argüman kabul ediyor.

Curl örneği (Önerilen)

Aşağıdaki Curl komutunu kullanarak ayarlayın home.example.com istek yapan istemcinin dış IP'sine:

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

Bu komutu bir crontab'ta, yerel bir makinede, her 15 dk ya da ona yakın bir şekilde ayarlayabilirsiniz.

Synology

Synology'de aşağıdaki sözdizimini Özel DDNS Sağlayıcı olarak kullanabilirsiniz

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

hostname daha sonra güncellemek istediğiniz tam nitelikli alan adı olarak girilmelidir, örn. 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'de bir Özel Dinamik DNS sağlayıcı ayarlayın ve "Server" alanına aşağıdaki dizeyi girin.

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