Ce document décrit l'API JSON RESTful de Simply.com.
Vous pouvez trouver le point de terminaison HTTP sur https://api.simply.com/2/ - préfixez vos requêtes avec ceci.
L'authentification se fait avec HTTP Basic Authentication.
Nom d'utilisateur est le numéro de compte Simply.com (Sxxxxxx).
Mot de passe est la clé API pour le compte spécifique.
Le numéro de compte et la clé API attribués à votre compte Simply.com peuvent être trouvés dans votre panneau de contrôle Simply.com.
Vous pouvez trouver la spécification OpenAPI pour l'API ici: https://api.simply.com/2/openapi.json.
Envisagez d'utiliser le navigateur Swagger UI ici: https://generator.swagger.io/.
L'API est soumise à des limites de taux, uniquement pour prévenir les abus.
Vous pouvez voir la limite et la consommation dans X-RateLimit-Limit et X-RateLimit-Remaining en-têtes.
Les bibliothèques suivantes sont disponibles pour utilisation.
| 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 |
| PHP | https://github.com/simplycom/api-php/ |
|---|
Les points de terminaison /ddns/ et /dyndns/ vous aide facilement à configurer le DDNS sur un domaine.
/dyndns/ émule strictement le protocole DynDns, tout en /ddns/ essaie de donner des réponses plus descriptives et accepte plusieurs arguments.
Utilisez la commande Curl suivante pour définir home.example.com à l'IP externe du client demandeur:
curl -s -u "ACCOUNTNAME:APIKEY" "https://api.simply.com/2/ddns/?domain=example.com&hostname=home.example.com"
Vous pouvez configurer cette commande pour qu'elle s'exécute dans une crontab, sur une machine locale, toutes les 15 minutes environ.
Sur Synology, vous pouvez utiliser la syntaxe suivante comme fournisseur DDNS personnalisé.
https://api.simply.com/2/dyndns/?hostname=__HOSTNAME__&myip=__MYIP__
hostname doit ensuite être indiqué comme le nom de domaine complet que vous souhaitez mettre à jour, par ex. home.example.com.
# 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
Dans UniFi OS, vous devez configurer un fournisseur DNS dynamique personnalisé et entrer la chaîne suivante dans le champ "Serveur".
api.simply.com/2/dyndns/?hostname=%h&myip=%i