Simply.com is available in english

Documentazione API di Simply.com

Questo documento descrive l'API JSON RESTful di Simply.com.

Endpoint API

Puoi trovare l'endpoint HTTP su https://api.simply.com/2/ - prefissa le tue richieste con questo.

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

Autenticazione

L'autenticazione avviene tramite HTTP Basic Authentication.

Nome utente è il numero di conto Simply.com (Sxxxxxx).

Codice di accesso è la chiave API per l'account specifico.

Sia il numero di conto che la chiave API assegnati al tuo account Simply.com possono essere trovati nel tuo pannello di controllo Simply.com.

Specifica OpenApi / Documentazione

Puoi trovare la specifica OpenAPI per l'API qui: https://api.simply.com/2/openapi.json.

Considera di utilizzare il browser Swagger UI qui: https://generator.swagger.io/.

Limiti di velocità

L'API è soggetta a limiti di velocità, solo per prevenire abusi.

Puoi vedere il limite e il consumo in X-RateLimit-Limit e X-RateLimit-Remaining intestazioni.

Implementazioni di librerie

Le seguenti librerie sono disponibili per l'uso.

Implementazioni 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

Implementazioni API

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

Esempi

Assistente DNS dinamico

Gli endpoint /ddns/ e /dyndns/ ti aiuta facilmente a configurare DDNS su un dominio.

/dyndns/ emula rigorosamente il protocollo DynDns, mentre /ddns/ cercando di fornire risposte più descrittive e accettare più argomenti.

Esempio di Curl (Consigliato)

Usa il seguente comando Curl per impostare home.example.com all'indirizzo IP esterno del client richiedente:

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

Puoi impostare questo comando per essere eseguito in un crontab, su una macchina locale, ogni 15 minuti o giù di lì.

Synology

Su Synology puoi utilizzare la seguente sintassi come provider DDNS personalizzato

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

hostname deve quindi essere indicato come il nome di dominio completamente qualificato che desideri aggiornare, ad es. 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

In UniFi OS, devi configurare un provider DNS dinamico personalizzato e inserire la seguente stringa nel campo "Server".

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