# Documentação da Interweb

Guias e referência da API da Interweb, para ligar os seus programas à sua conta.

Actualizado em 04/11/2026

## Comece aqui

- [Começar com a API](https://docs.interweb.ao/pt/getting-started.md): Do primeiro pedido à primeira chave, em poucos minutos.
- [Autenticação e chaves](https://docs.interweb.ao/pt/authentication.md): Como criar uma chave, usá-la nos pedidos e mantê-la segura.
- [Permissões](https://docs.interweb.ao/pt/permissions.md): O que cada chave pode fazer, por área, e as permissões que ficam separadas.
- [Regras da API](https://docs.interweb.ao/pt/api-rules.md): As regras que valem em todas as operações: erros, limites, paginação, repetições e os modos Sandbox e Produção.
- [Referência da API](https://docs.interweb.ao/pt/reference.md): Todas as operações da API, com filtro, a ligar à página de cada área.
- [Playground](https://docs.interweb.ao/pt/playground.md): Escolha uma operação, preencha o pedido e veja a resposta da API, com o código pronto em curl, PHP, Python e JavaScript.

## O que a API já faz

A API está a crescer por fases. Nesta versão tem 148 operações:

- `GET` [`/v1/ping`](https://docs.interweb.ao/pt/key-status.md): Confirmar que a API responde
- `GET` [`/v1/token`](https://docs.interweb.ao/pt/key-status.md): Ver a chave em uso
- `GET` [`/v1/limits`](https://docs.interweb.ao/pt/key-status.md): Ver os limites da chave
- `GET` [`/v1/actions/{id}`](https://docs.interweb.ao/pt/key-status.md): Acompanhar uma operação longa
- `GET` [`/v1/openapi.json`](https://docs.interweb.ao/pt/key-status.md): Descarregar esta especificação
- `GET` [`/v1/sms/messages`](https://docs.interweb.ao/pt/sms.md): Listar as mensagens enviadas
- `POST` [`/v1/sms/messages`](https://docs.interweb.ao/pt/sms.md): Enviar um SMS
- `GET` [`/v1/sms/messages/{id}`](https://docs.interweb.ao/pt/sms.md): Ver um SMS
- `GET` [`/v1/sms/balance`](https://docs.interweb.ao/pt/sms.md): Ver o saldo de SMS
- `GET` [`/v1/sms/senders`](https://docs.interweb.ao/pt/sms.md): Listar os remetentes de SMS
- `POST` [`/v1/sms/senders`](https://docs.interweb.ao/pt/sms.md): Pedir um remetente
- `GET` [`/v1/account`](https://docs.interweb.ao/pt/account.md): Ver a conta
- `GET` [`/v1/account/contacts`](https://docs.interweb.ao/pt/account.md): Listar os contactos
- `GET` [`/v1/account/users`](https://docs.interweb.ao/pt/account.md): Listar os utilizadores
- `GET` [`/v1/catalog/products`](https://docs.interweb.ao/pt/catalog.md): Listar os produtos
- `GET` [`/v1/catalog/tlds`](https://docs.interweb.ao/pt/catalog.md): Listar as extensões de domínio
- `GET` [`/v1/catalog/currencies`](https://docs.interweb.ao/pt/catalog.md): Listar as moedas
- `GET` [`/v1/catalog/billing-cycles`](https://docs.interweb.ao/pt/catalog.md): Listar os ciclos de pagamento
- `GET` [`/v1/domains`](https://docs.interweb.ao/pt/domains.md): Listar os domínios
- `GET` [`/v1/domains/{domain}`](https://docs.interweb.ao/pt/domains.md): Ver um domínio
- `GET` [`/v1/services`](https://docs.interweb.ao/pt/hosting.md): Listar os serviços
- `GET` [`/v1/services/{id}`](https://docs.interweb.ao/pt/hosting.md): Ver um serviço
- `GET` [`/v1/invoices`](https://docs.interweb.ao/pt/billing.md): Listar as facturas
- `GET` [`/v1/invoices/{id}`](https://docs.interweb.ao/pt/billing.md): Ver uma factura
- `GET` [`/v1/billing/credit`](https://docs.interweb.ao/pt/billing.md): Ver o saldo
- `GET` [`/v1/billing/transactions`](https://docs.interweb.ao/pt/billing.md): Listar as transacções
- `GET` [`/v1/tickets`](https://docs.interweb.ao/pt/support.md): Listar os tickets
- `POST` [`/v1/tickets`](https://docs.interweb.ao/pt/support.md): Abrir um ticket
- `GET` [`/v1/tickets/{id}`](https://docs.interweb.ao/pt/support.md): Ver um ticket
- `GET` [`/v1/support/departments`](https://docs.interweb.ao/pt/support.md): Listar os departamentos
- `GET` [`/v1/domains/availability`](https://docs.interweb.ao/pt/domains.md): Consultar um nome de domínio
- `POST` [`/v1/domains/register`](https://docs.interweb.ao/pt/domains.md): Registar um domínio
- `POST` [`/v1/domains/transfer`](https://docs.interweb.ao/pt/domains.md): Transferir um domínio para nós
- `POST` [`/v1/domains/{domain}/renew`](https://docs.interweb.ao/pt/domains.md): Renovar um domínio
- `GET` [`/v1/domains/{domain}/nameservers`](https://docs.interweb.ao/pt/domains.md): Ver os nameservers
- `PUT` [`/v1/domains/{domain}/nameservers`](https://docs.interweb.ao/pt/domains.md): Mudar os nameservers
- `GET` [`/v1/domains/{domain}/lock`](https://docs.interweb.ao/pt/domains.md): Ver o bloqueio de transferência
- `PUT` [`/v1/domains/{domain}/lock`](https://docs.interweb.ao/pt/domains.md): Mudar o bloqueio de transferência
- `PUT` [`/v1/domains/{domain}/auto-renew`](https://docs.interweb.ao/pt/domains.md): Mudar a renovação automática
- `GET` [`/v1/domains/{domain}/contacts`](https://docs.interweb.ao/pt/domains.md): Ver os contactos do domínio
- `POST` [`/v1/domains/{domain}/transfer-code`](https://docs.interweb.ao/pt/domains.md): Pedir o código de transferência
- `GET` [`/v1/domains/{domain}/dns`](https://docs.interweb.ao/pt/dns.md): Listar os registos DNS
- `POST` [`/v1/domains/{domain}/dns`](https://docs.interweb.ao/pt/dns.md): Adicionar um registo DNS
- `POST` [`/v1/domains/{domain}/dns/validate`](https://docs.interweb.ao/pt/dns.md): Validar um registo DNS
- `PUT` [`/v1/domains/{domain}/dns/{record_id}`](https://docs.interweb.ao/pt/dns.md): Alterar um registo DNS
- `DELETE` [`/v1/domains/{domain}/dns/{record_id}`](https://docs.interweb.ao/pt/dns.md): Apagar um registo DNS
- `POST` [`/v1/domains/{domain}/dns/reset`](https://docs.interweb.ao/pt/dns.md): Repor a zona DNS
- `GET` [`/v1/domains/{domain}/dns/backups`](https://docs.interweb.ao/pt/dns.md): Listar as cópias da zona
- `POST` [`/v1/domains/{domain}/dns/backups/{id}/restore`](https://docs.interweb.ao/pt/dns.md): Restaurar uma cópia da zona
- `GET` [`/v1/invoices/{id}/pdf`](https://docs.interweb.ao/pt/billing.md): Obter o PDF de uma factura
- `POST` [`/v1/invoices/{id}/pay`](https://docs.interweb.ao/pt/billing.md): Pagar uma factura com saldo
- `GET` [`/v1/orders`](https://docs.interweb.ao/pt/billing.md): Listar as encomendas
- `GET` [`/v1/orders/{id}`](https://docs.interweb.ao/pt/billing.md): Ver uma encomenda
- `GET` [`/v1/quotes`](https://docs.interweb.ao/pt/billing.md): Listar as cotações
- `GET` [`/v1/quotes/{id}`](https://docs.interweb.ao/pt/billing.md): Ver uma cotação
- `GET` [`/v1/services/{id}/billing-cycles`](https://docs.interweb.ao/pt/billing.md): Ver os ciclos de renovação de um serviço
- `PUT` [`/v1/services/{id}/billing-cycle`](https://docs.interweb.ao/pt/billing.md): Mudar o ciclo da próxima renovação
- `GET` [`/v1/services/{id}/upgrade-link`](https://docs.interweb.ao/pt/billing.md): Obter a ligação de upgrade de um serviço
- `POST` [`/v1/services/{id}/cancellation`](https://docs.interweb.ao/pt/billing.md): Pedir o cancelamento de um serviço
- `POST` [`/v1/tickets/{id}/replies`](https://docs.interweb.ao/pt/support.md): Responder a um ticket
- `POST` [`/v1/tickets/{id}/close`](https://docs.interweb.ao/pt/support.md): Fechar um ticket
- `GET` [`/v1/kb/categories`](https://docs.interweb.ao/pt/support.md): Listar as categorias da Base de Conhecimento
- `GET` [`/v1/kb/articles`](https://docs.interweb.ao/pt/support.md): Listar ou pesquisar artigos da Base de Conhecimento
- `GET` [`/v1/kb/articles/{id}`](https://docs.interweb.ao/pt/support.md): Ler um artigo da Base de Conhecimento
- `GET` [`/v1/announcements`](https://docs.interweb.ao/pt/support.md): Listar os anúncios
- `GET` [`/v1/announcements/{id}`](https://docs.interweb.ao/pt/support.md): Ler um anúncio
- `GET` [`/v1/servers`](https://docs.interweb.ao/pt/servers.md): Listar os servidores
- `GET` [`/v1/servers/{id}`](https://docs.interweb.ao/pt/servers.md): Ver um servidor
- `GET` [`/v1/servers/{id}/traffic`](https://docs.interweb.ao/pt/servers.md): Ver o tráfego do mês
- `GET` [`/v1/servers/{id}/operating-systems`](https://docs.interweb.ao/pt/servers.md): Listar os sistemas para reinstalar
- `GET` [`/v1/servers/{id}/backups`](https://docs.interweb.ao/pt/servers.md): Listar as cópias
- `POST` [`/v1/servers/{id}/backups`](https://docs.interweb.ao/pt/servers.md): Fazer uma cópia
- `POST` [`/v1/servers/{id}/start`](https://docs.interweb.ao/pt/servers.md): Ligar um servidor
- `POST` [`/v1/servers/{id}/stop`](https://docs.interweb.ao/pt/servers.md): Desligar um servidor
- `POST` [`/v1/servers/{id}/restart`](https://docs.interweb.ao/pt/servers.md): Reiniciar um servidor
- `POST` [`/v1/servers/{id}/password`](https://docs.interweb.ao/pt/servers.md): Gerar uma nova senha de root
- `GET` [`/v1/servers/{id}/reverse-dns`](https://docs.interweb.ao/pt/servers.md): Ver o DNS reverso
- `PUT` [`/v1/servers/{id}/reverse-dns`](https://docs.interweb.ao/pt/servers.md): Mudar o DNS reverso
- `GET` [`/v1/servers/{id}/timezone`](https://docs.interweb.ao/pt/servers.md): Ver o fuso horário
- `PUT` [`/v1/servers/{id}/timezone`](https://docs.interweb.ao/pt/servers.md): Mudar o fuso horário
- `POST` [`/v1/servers/{id}/reinstall`](https://docs.interweb.ao/pt/servers.md): Reinstalar um servidor
- `POST` [`/v1/servers/{id}/restore`](https://docs.interweb.ao/pt/servers.md): Restaurar uma cópia
- `GET` [`/v1/services/{id}/usage`](https://docs.interweb.ao/pt/hosting.md): Ver o uso de disco, tráfego e recursos
- `POST` [`/v1/services/{id}/cpanel-login`](https://docs.interweb.ao/pt/hosting.md): Criar uma ligação de entrada directa
- `GET` [`/v1/services/{id}/subdomains`](https://docs.interweb.ao/pt/hosting.md): Listar subdomínios
- `POST` [`/v1/services/{id}/subdomains`](https://docs.interweb.ao/pt/hosting.md): Criar um subdomínio
- `DELETE` [`/v1/services/{id}/subdomains/{domain}`](https://docs.interweb.ao/pt/hosting.md): Apagar um subdomínio
- `GET` [`/v1/services/{id}/addon-domains`](https://docs.interweb.ao/pt/hosting.md): Listar domínios adicionais
- `POST` [`/v1/services/{id}/addon-domains`](https://docs.interweb.ao/pt/hosting.md): Adicionar um domínio adicional
- `DELETE` [`/v1/services/{id}/addon-domains/{domain}`](https://docs.interweb.ao/pt/hosting.md): Retirar um domínio adicional
- `GET` [`/v1/services/{id}/redirects`](https://docs.interweb.ao/pt/hosting.md): Listar redireccionamentos
- `POST` [`/v1/services/{id}/redirects`](https://docs.interweb.ao/pt/hosting.md): Criar um redireccionamento
- `DELETE` [`/v1/services/{id}/redirects/{redirect_id}`](https://docs.interweb.ao/pt/hosting.md): Apagar um redireccionamento
- `GET` [`/v1/services/{id}/databases`](https://docs.interweb.ao/pt/hosting.md): Listar bases de dados
- `POST` [`/v1/services/{id}/databases`](https://docs.interweb.ao/pt/hosting.md): Criar uma base de dados
- `DELETE` [`/v1/services/{id}/databases/{name}`](https://docs.interweb.ao/pt/hosting.md): Apagar uma base de dados
- `GET` [`/v1/services/{id}/database-users`](https://docs.interweb.ao/pt/hosting.md): Listar utilizadores de bases de dados
- `POST` [`/v1/services/{id}/database-users`](https://docs.interweb.ao/pt/hosting.md): Criar um utilizador de bases de dados
- `PUT` [`/v1/services/{id}/database-users/{name}/password`](https://docs.interweb.ao/pt/hosting.md): Mudar a senha de um utilizador de bases de dados
- `DELETE` [`/v1/services/{id}/database-users/{name}`](https://docs.interweb.ao/pt/hosting.md): Apagar um utilizador de bases de dados
- `PUT` [`/v1/services/{id}/databases/{name}/users/{user}`](https://docs.interweb.ao/pt/hosting.md): Dar a um utilizador acesso a uma base
- `DELETE` [`/v1/services/{id}/databases/{name}/users/{user}`](https://docs.interweb.ao/pt/hosting.md): Retirar o acesso de um utilizador a uma base
- `GET` [`/v1/services/{id}/cron`](https://docs.interweb.ao/pt/hosting.md): Listar tarefas cron
- `POST` [`/v1/services/{id}/cron`](https://docs.interweb.ao/pt/hosting.md): Criar uma tarefa cron
- `DELETE` [`/v1/services/{id}/cron/{cron_id}`](https://docs.interweb.ao/pt/hosting.md): Apagar uma tarefa cron
- `GET` [`/v1/services/{id}/ssl`](https://docs.interweb.ao/pt/hosting.md): Ver os certificados SSL
- `POST` [`/v1/services/{id}/ssl/autossl`](https://docs.interweb.ao/pt/hosting.md): Pedir certificados gratuitos
- `GET` [`/v1/services/{id}/php`](https://docs.interweb.ao/pt/hosting.md): Ver a versão do PHP de cada site
- `GET` [`/v1/services/{id}/php/options`](https://docs.interweb.ao/pt/hosting.md): Ver as opções do PHP
- `PUT` [`/v1/services/{id}/php/options`](https://docs.interweb.ao/pt/hosting.md): Alterar as opções do PHP
- `GET` [`/v1/services/{id}/backups`](https://docs.interweb.ao/pt/hosting.md): Listar as datas das cópias
- `POST` [`/v1/services/{id}/backups`](https://docs.interweb.ao/pt/hosting.md): Pedir uma cópia completa
- `GET` [`/v1/services/{id}/ftp-accounts`](https://docs.interweb.ao/pt/hosting.md): Listar acessos FTP
- `POST` [`/v1/services/{id}/ftp-accounts`](https://docs.interweb.ao/pt/hosting.md): Criar um acesso FTP
- `PUT` [`/v1/services/{id}/ftp-accounts/{login}/password`](https://docs.interweb.ao/pt/hosting.md): Mudar a senha de um acesso FTP
- `DELETE` [`/v1/services/{id}/ftp-accounts/{login}`](https://docs.interweb.ao/pt/hosting.md): Apagar um acesso FTP
- `GET` [`/v1/services/{id}/email/mailboxes`](https://docs.interweb.ao/pt/email.md): Listar caixas de e-mail
- `POST` [`/v1/services/{id}/email/mailboxes`](https://docs.interweb.ao/pt/email.md): Criar uma caixa de e-mail
- `DELETE` [`/v1/services/{id}/email/mailboxes/{address}`](https://docs.interweb.ao/pt/email.md): Apagar uma caixa de e-mail
- `PUT` [`/v1/services/{id}/email/mailboxes/{address}/password`](https://docs.interweb.ao/pt/email.md): Mudar a senha de uma caixa
- `PUT` [`/v1/services/{id}/email/mailboxes/{address}/quota`](https://docs.interweb.ao/pt/email.md): Mudar a quota de uma caixa
- `GET` [`/v1/services/{id}/email/forwarders`](https://docs.interweb.ao/pt/email.md): Listar reencaminhadores
- `POST` [`/v1/services/{id}/email/forwarders`](https://docs.interweb.ao/pt/email.md): Criar um reencaminhador
- `DELETE` [`/v1/services/{id}/email/forwarders/{address}/{forward_to}`](https://docs.interweb.ao/pt/email.md): Apagar um reencaminhador
- `GET` [`/v1/services/{id}/email/autoresponders`](https://docs.interweb.ao/pt/email.md): Listar respostas automáticas
- `GET` [`/v1/services/{id}/email/autoresponders/{address}`](https://docs.interweb.ao/pt/email.md): Ver uma resposta automática
- `PUT` [`/v1/services/{id}/email/autoresponders/{address}`](https://docs.interweb.ao/pt/email.md): Gravar uma resposta automática
- `DELETE` [`/v1/services/{id}/email/autoresponders/{address}`](https://docs.interweb.ao/pt/email.md): Apagar uma resposta automática
- `GET` [`/v1/services/{id}/email/default-address`](https://docs.interweb.ao/pt/email.md): Ver a conta geral
- `PUT` [`/v1/services/{id}/email/default-address`](https://docs.interweb.ao/pt/email.md): Alterar a conta geral
- `GET` [`/v1/services/{id}/email/authentication`](https://docs.interweb.ao/pt/email.md): Ver SPF, DKIM e DMARC
- `GET` [`/v1/sms/stats`](https://docs.interweb.ao/pt/sms.md): Ver as estatísticas de envio
- `GET` [`/v1/sms/templates`](https://docs.interweb.ao/pt/sms.md): Listar os modelos
- `POST` [`/v1/sms/templates`](https://docs.interweb.ao/pt/sms.md): Criar um modelo
- `GET` [`/v1/sms/templates/{id}`](https://docs.interweb.ao/pt/sms.md): Ver um modelo
- `PATCH` [`/v1/sms/templates/{id}`](https://docs.interweb.ao/pt/sms.md): Alterar um modelo
- `DELETE` [`/v1/sms/templates/{id}`](https://docs.interweb.ao/pt/sms.md): Apagar um modelo
- `GET` [`/v1/sms/senders/{sender}`](https://docs.interweb.ao/pt/sms.md): Ver um pedido de remetente
- `GET` [`/v1/sms/opt-outs`](https://docs.interweb.ao/pt/sms.md): Listar os números que não recebem
- `POST` [`/v1/sms/opt-outs`](https://docs.interweb.ao/pt/sms.md): Deixar de enviar a um número
- `GET` [`/v1/extras/catalog`](https://docs.interweb.ao/pt/extras.md): Listar os extras à venda
- `GET` [`/v1/extras`](https://docs.interweb.ao/pt/extras.md): Listar os extras da conta
- `GET` [`/v1/extras/{id}`](https://docs.interweb.ao/pt/extras.md): Ver um extra
- `POST` [`/v1/extras/purchase`](https://docs.interweb.ao/pt/extras.md): Comprar um extra
- `GET` [`/v1/reseller`](https://docs.interweb.ao/pt/reseller.md): Ver os programas de revenda
- `GET` [`/v1/reseller/services`](https://docs.interweb.ao/pt/reseller.md): Listar as contas de revenda
- `GET` [`/v1/reseller/services/{id}`](https://docs.interweb.ao/pt/reseller.md): Ver uma conta de revenda
- `POST` [`/v1/sms/messages/{id}/cancel`](https://docs.interweb.ao/pt/sms.md): Cancelar um SMS agendado

O que não está nesta lista ainda não existe na API. Para já, essas tarefas fazem-se no Meu Interweb.

## Áreas da API

- [Domínios](https://docs.interweb.ao/pt/domains.md): Consultar, registar, renovar e transferir domínios, e gerir nameservers, bloqueio e renovação automática pela API.
- [DNS](https://docs.interweb.ao/pt/dns.md): Ler e alterar as zonas DNS dos seus domínios pela API, com cópia antes de cada alteração.
- [Hospedagem](https://docs.interweb.ao/pt/hosting.md): Ver os serviços da conta e gerir uma hospedagem pela API: uso, domínios, bases de dados, cron, SSL, PHP, cópias e FTP.
- [E-mail](https://docs.interweb.ao/pt/email.md): Gerir as caixas de e-mail de uma hospedagem pela API: senhas, quotas, reencaminhadores, respostas automáticas, conta geral, SPF, DKIM e DMARC.
- [Servidores](https://docs.interweb.ao/pt/servers.md): Ver o estado, ligar, desligar, reiniciar, mudar a senha e reinstalar os seus servidores VPS pela API.
- [SMS](https://docs.interweb.ao/pt/sms.md): Envie SMS pela API e veja o histórico, as estatísticas, o saldo, os modelos, os remetentes e os números que não recebem.
- [Facturas e saldo](https://docs.interweb.ao/pt/billing.md): Consultar e pagar facturas com saldo, ver encomendas e cotações, mudar o ciclo de renovação e pedir um cancelamento pela API.
- [Conta e segurança](https://docs.interweb.ao/pt/account.md): Ver os dados da conta, os contactos e os utilizadores pela API.
- [Catálogo](https://docs.interweb.ao/pt/catalog.md): Ver os produtos, as extensões de domínio, as moedas e os ciclos de pagamento pela API.
- [Suporte](https://docs.interweb.ao/pt/support.md): Abrir, responder e fechar tickets, e ler os artigos da Base de Conhecimento e os anúncios pela API.
- [Produtos extra](https://docs.interweb.ao/pt/extras.md): Veja os certificados, o SiteLock, a rádio e outros extras da conta, consulte o catálogo e compre com saldo pela API.
- [Revenda](https://docs.interweb.ao/pt/reseller.md): Veja os programas de revenda da conta e as contas de revenda de hospedagem pela API.
- [Chave e estado](https://docs.interweb.ao/pt/key-status.md): Confirmar que a API responde, ver o que a chave pode fazer, acompanhar operações longas e descarregar a especificação.