A nossa API numa página: o que pode automatizar na sua conta, área a área

WhatsApp e APIs·· 29 visualizações· 4 min de leitura

A resposta curta: a API deixa o seu programa fazer, sozinho, muito do que faz à mão no My MozOut: 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 My MozOut.

O essencial, num quadro

O quê Como é
Endereço base https://api.mozout.com/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.
E-mail 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 My MozOut. 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 é

1 Revendedores e agências: registam domínios, mudam o DNS e criam caixas de e-mail para os seus clientes sem abrir o My MozOut. Veja a API para revendedores.
2 Sistemas de gestão e sites: consultam e pagam facturas com o saldo, abrem pedidos de suporte ou enviam SMS aos clientes.
3 Automação de servidores: scripts que ligam, reiniciam ou reinstalam um VPS e mantêm os nameservers e o DNS actualizados.

Como começar

1 Teste a ligação. GET /v1/ping responde sem chave: é o melhor primeiro teste.
2 Crie uma chave Sandbox na página API, só com as permissões de que precisa. O passo a passo está em criar uma chave da API.
3 Faça o primeiro pedido com chave: GET /v1/token mostra o modo, as permissões, a validade e os limites da chave.
4 Quando o programa estiver pronto, crie uma chave de Produção. O endereço e as operações são os mesmos: veja Sandbox ou Produção.

curl https://api.mozout.com/v1/ping
curl https://api.mozout.com/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

VEJA TAMBÉM

Criar uma chave da API: nome, modo, permissões, validade, lista de IPs e limite de gastos

Sandbox ou Produção na API: o que faz cada chave, e como passar o programa para produção

Permissões da API por área: ler ou alterar, e que permissão pede cada tarefa

Os códigos de erro da nossa API: o que quer dizer cada um, e quais vale a pena repetir

Limites de pedidos da API: por chave, por conta e por tarefa, os cabeçalhos e o que fazer num 429

O que é uma API, em palavras simples: pedidos, respostas e um exemplo REST

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde $6.60/mês (plano de 3 anos, com cupão)

Ver planos
Esta resposta foi útil? A sua resposta ajuda-nos a melhorar este artigo.