Documentación de la API

Punto final de API

Puedes encontrar el endpoint HTTP en https://api.simply.com/2/ - prefija tus solicitudes con esto.

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

Autenticación

La autenticación se realiza con HTTP Basic Authentication.

Código de acceso es la clave API para la cuenta específica.

Nombre de usuario Puede ser cualquier cosa, ya que la clave API por sí sola identifica la cuenta.

Alternativamente, la clave API puede enviarse como Bearer-token en el encabezado Authorization:

Authorization: Bearer APIKEY

Las claves API se crean en el panel de control de Simply.com bajo Cuenta, Claves API.

Especificación / Documentación de OpenApi

Puedes encontrar la documentación interactiva de la API aquí: https://api.simply.com/2/doc/

O descarga la especificación OpenAPI como JSON: https://api.simply.com/2/doc.json

Límites de tasa

La API está sujeta a límites de tasa, solo para prevenir el abuso.

Puedes ver el límite y el consumo en X-RateLimit-Limit y X-RateLimit-Remaining encabezados.

Implementaciones de bibliotecas

Los siguientes bibliotecas están disponibles para su uso.

Implementaciones de 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

Implementaciones de API

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

Asistente de DNS dinámico

Los puntos finales /ddns/ y /dyndns/ te ayuda fácilmente a configurar DDNS en un dominio.

/dyndns/ emula estrictamente el protocolo DynDns, mientras /ddns/ intentando dar respuestas más descriptivas y aceptar más argumentos.

Ejemplo de Curl (Recomendado)

Utiliza el siguiente comando Curl para establecer home.example.com a la IP externa del cliente solicitante:

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

Puedes configurar este comando para que se ejecute en un crontab, en una máquina local, cada 15 minutos o algo así.

Synology

En Synology, puedes usar la siguiente sintaxis como proveedor DDNS personalizado.

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

hostname debe indicarse como el nombre de dominio completo calificado que desea actualizar, p. ej. 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

En UniFi OS, debes configurar un proveedor de DNS dinámico personalizado e ingresar la siguiente cadena en el campo "Servidor".

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

Documentación de la API de Simply.com