Documentação da API

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.

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

Nome de utilizador pode ser qualquer coisa, já que a chave API identifica a conta por si só.

Alternativamente, a chave API pode ser enviada como Bearer-token no cabeçalho Authorization:

Authorization: Bearer APIKEY

As chaves API são criadas no Painel de controlo da Simply.com em Conta, Chaves API.

Especificação OpenApi / Documentação

Pode encontrar a documentação interativa da API aqui: https://api.simply.com/2/doc/

Ou transfira a especificação OpenAPI como JSON: https://api.simply.com/2/doc.json

Limites de taxa

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

Ao exceder o limite, a API responde com 429 e indica o tempo de espera em Retry-After.

Simply.com AI Connector (MCP)

Ligue Claude, Cursor, Codex e outros assistentes de IA ao Simply.com via MCP. Corrija o DNS, altere os servidores de nomes, encontre domínios disponíveis, crie contas de e-mail e verifique ficheiros de log, basta pedir.

Ler mais

Implementações de bibliotecas

As 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

ddns.simply.com (DynDNS2)

Roteadores e clientes DDNS que suportam o protocolo DynDNS2 podem usar o host ddns.simply.com diretamente.

Para scripts e outra automação de DNS recomendamos a REST API, que pode criar, alterar e eliminar registos DNS.

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

A autenticação ocorre com HTTP Basic Authentication, onde a palavra-passe é a chave API da conta. O nome de utilizador pode ser qualquer coisa, por exemplo o nome da conta.

Se for omitido myip, será usado o endereço IP de onde a solicitação provém. As atualizações devem ser feitas através de HTTPS.

O registo deve ser encontrado na zona DNS antes de poder ser atualizado: um registo A para IPv4 e um registo AAAA para IPv6. Se não existir, responde-se nohost, então crie o registo no painel de controlo primeiro.

O parâmetro domain indica o domínio. Deve ser incluído, quando o próprio domínio for atualizado, por exemplo hostname=example.com&domain=example.com, e pode ser usado, quando o domínio não pode ser deduzido a partir de hostname.

As respostas seguem o protocolo DynDNS2, por exemplo good numa atualização e nochg, quando o endereço IP não foi alterado.

O endereço https://ddns.simply.com/myip retorna o endereço IP público de onde a solicitação provém, e não requer autenticação.

ddclient

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

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://ddns.simply.com/nic/update?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://ddns.simply.com/nic/update?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

O sensor obtém o endereço IP público a cada 5 minutos, e a automação atualiza o DNS apenas quando o endereço muda, e quando o Home Assistant inicia. A chave API é guardada em secrets.yaml.

# 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

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

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

Documentação da API Simply.com