Português
English
A resposta curta: a API deixa o seu programa fazer, sozinho, muito do que faz à mão no Meu Interweb: registar domínios, mudar o DNS, criar caixas de e-mail, reiniciar um VPS, pagar facturas com o saldo ou abrir um pedido de suporte. É uma API REST, responde em JSON, só funciona por HTTPS e cada pedido leva uma chave, que cria na página API do Meu Interweb.
O essencial, num quadro
| O quê | Como é |
| Endereço base | https://api.interweb.co.mz/v1 |
| Formato | JSON sobre HTTPS. Os nomes dos campos estão em inglês. |
| Autenticação | Uma chave no cabeçalho Authorization: Bearer ..., nunca no endereço. |
| Dois modos | Sandbox (sandbox_): lê dados verdadeiros e simula as alterações. Produção (prod_): lê e altera a conta. |
| Línguas | As mensagens de erro vêm em português ou em inglês, conforme o cabeçalho Accept-Language. Sem ele, vêm em inglês. |
| Quem pode usar | O dono de uma conta com um serviço ou um domínio activo. Até 20 chaves por conta. |
O que faz, área a área
| Área | Exemplos do que faz |
| Domínios | Consultar um nome, registar, renovar, transferir, mudar nameservers, bloqueio e renovação automática. |
| DNS | Ler a zona, criar, alterar e apagar registos, restaurar uma cópia da zona. |
| Hospedagem | Uso do plano, subdomínios, domínios adicionais, bases de dados, cron, SSL, opções do PHP, cópias e FTP. |
| Caixas, senhas, quotas, reencaminhadores, respostas automáticas, conta geral e o estado do SPF, DKIM e DMARC. | |
| Servidores VPS | Ver o estado, ligar, desligar, reiniciar, senha de root, cópias, reinstalar e restaurar. |
| SMS | Enviar mensagens e consultar o saldo, o histórico e os modelos. |
| Facturas | Listar, descarregar o PDF, pagar com saldo, mudar o ciclo de renovação e pedir um cancelamento. |
| Conta | Ler os dados da conta, os contactos e os utilizadores. |
| Catálogo | Produtos, extensões de domínio, moedas e ciclos, com preços. |
| Suporte | Abrir, responder e fechar pedidos de suporte, ler a Base de Conhecimento e os anúncios. |
| Extras | Ver os certificados SSL, o SiteLock e outros extras, e comprar alguns com saldo. |
| Revenda | Ver os programas de revenda e as contas de revenda de hospedagem. |
O que não está na API ainda não existe nela: faz-se no Meu Interweb. A API está a crescer por fases, e a documentação diz, em cada área, o que já existe e o que está previsto.
Para quem é
|
|
|
Como começar
|
|
|
|
curl https://api.interweb.co.mz/v1/ping
curl https://api.interweb.co.mz/v1/token -H "Authorization: Bearer $RLX_API_KEY"
| Uma resposta certa traz sempre data e meta; uma com erro traz error, com um código que não muda. Todas trazem o cabeçalho X-Correlation-ID: guarde-o, porque é o que o suporte precisa para encontrar o pedido. Se a palavra API ainda é nova para si, comece por o que é uma API, em palavras simples. |
|
Quer ligar os seus programas à conta? A página da API tem o resumo, a documentação com exemplos e o botão para criar a primeira chave. Ver a página da API |
PRODUTO RECOMENDADO Hospedagem de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 321,75 MT/mês (plano de 3 anos, com cupão) Ver planos |
