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.

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

Kullanıcı adı herhangi bir şey olabilir, çünkü API anahtarı yalnızca hesabı tanımlar.

Alternatif olarak API anahtarı Bearer-token olarak Authorization başlığında gönderilebilir:

Authorization: Bearer APIKEY

API anahtarları, Simply.com Kontrol Paneli'nde Hesap, API anahtarları altında oluşturulur.

OpenApi Spec / Dokümantasyon

Etkileşimli API dokümantasyonunu burada bulabilirsiniz: https://api.simply.com/2/doc/

Ya da OpenAPI spesifikasyonunu JSON olarak indir: https://api.simply.com/2/doc.json

İstek sınırları

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

Aşım durumunda API 429 yanıt verir ve bekleme süresini Retry-After içinde belirtir.

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/

ddns.simply.com (DynDNS2)

DynDNS2 protokolünü destekleyen routerlar ve DDNS istemcileri, ddns.simply.com sunucusunu doğrudan kullanabilir.

Betikler ve diğer DNS otomasyonu için REST API'yi öneriyoruz, bu API DNS kayıtlarını oluşturabilir, değiştirebilir ve silebilir.

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

Kimlik doğrulama, HTTP Basic Authentication ile gerçekleşir, şifre hesabın API anahtarıdır. Kullanıcı adı her şey olabilir, örneğin hesap adı.

Eğer myip dışarıda bırakılırsa, isteğin geldiği IP adresi kullanılır. Güncellemeler HTTPS üzerinden yapılmalıdır.

Kayıt, DNS bölgesinde bulunmalı, güncellenebilmesi için: IPv4 için bir A-record ve IPv6 için bir AAAA-record. Bulunamazsa, nohost yanıtı verilir, bu yüzden önce kontrol panelinde kaydı oluşturun.

Parametre domain alan adını belirtir. Bu, alan adı güncellendiğinde gönderilmelidir, örneğin hostname=example.com&domain=example.com, ve hostname üzerinden alan adı çıkarılamadığında kullanılabilir.

Cevaplar DynDNS2 protokolünü izler, örneğin bir güncellemede good ve IP adresi değişmediğinde nochg.

Adres https://ddns.simply.com/myip isteğin geldiği genel IP adresini döndürür ve kimlik doğrulama gerektirmez.

ddclient

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

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://ddns.simply.com/nic/update?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://ddns.simply.com/nic/update?hostname=__HOSTNAME__&myip=__MYIP__

hostname daha sonra güncellemek istediğiniz tam nitelikli alan adı olarak girilmelidir, örn. home.example.com.

Home Assistant

Duyucu, her 5 dakikada bir genel IP adresini alır ve otomasyon yalnızca DNS'i, adres değiştiğinde ve Home Assistant başlatıldığında günceller. API anahtarı secrets.yaml içinde saklanır.

# 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

UniFi OS'de bir Özel Dinamik DNS sağlayıcı ayarlayın ve "Server" alanına aşağıdaki dizeyi girin.

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