Simply.com is available in english

Documentação da API Simply.com

Este documento descreve a API JSON RESTful da Simply.com.

Ponto final da API

Pode encontrar o endpoint HTTP em https://api.simply.com/2/ - prefixe as suas solicitações com isto.

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

Autenticação

A autenticação é feita com HTTP Basic Authentication.

Nome de utilizador é o número de conta Simply.com (Sxxxxxx).

Palavra-passe é a chave API para a conta específica.

Tanto o número de conta como a chave API atribuídos à sua conta Simply.com podem ser encontrados no seu painel de controlo Simply.com.

Especificação OpenApi / Documentação

Pode encontrar a especificação OpenAPI para a API aqui: https://api.simply.com/2/openapi.json .

Considere usar o navegador Swagger UI aqui: https://generator.swagger.io/ .

Limites de taxa

A API está sujeita a limites de taxa, apenas para prevenir abusos.

Pode ver o limite e o consumo em X-RateLimit-Limit e X-RateLimit-Remaining cabeçalhos.

Implementações de bibliotecas

Os seguintes bibliotecas estão disponíveis para uso.

Implementações 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

Implementações de API

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

Exemplos

Assistente de DNS Dinâmico

Os endpoints /ddns/ e /dyndns/ ajuda-o a configurar facilmente o DDNS num domínio.

/dyndns/ emula estritamente o protocolo DynDns, enquanto /ddns/ tenta dar respostas mais descritivas e aceita mais argumentos.

Exemplo de Curl (Recomendado)

Use o seguinte comando Curl para definir home.example.com para o IP externo do cliente solicitante:

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

Pode configurar este comando para ser executado num crontab, numa máquina local, a cada 15 minutos ou por aí.

Synology

No Synology, pode usar a seguinte sintaxe como Provedor DDNS Personalizado

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

hostname deve então ser especificado como o nome de domínio totalmente qualificado que deseja atualizar, por exemplo. 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

No UniFi OS, deves configurar um fornecedor de DNS Dinâmico Personalizado e inserir a seguinte string no campo "Servidor".

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