A resposta curta: cada área da API (Domínios, DNS, SMS, Faturas e saldo, e as outras) tem uma página com duas partes. Em cima, a explicação: o que precisa e como se faz cada tarefa. Em baixo, a lista de operações, cada uma com tudo o que é preciso para a chamar.
A explicação, em cima
Quase todas começam por «O que precisa», que diz a permissão que a chave tem que ter e, quando é o caso, o serviço que a conta precisa de ter activo. Seguem-se seções por tarefa, com links para as operações. Algumas páginas terminam em «O que está previsto»: é a lista do que ainda não existe na API e, por agora, se faz no My MozOut. O tempo de leitura no topo da página é o desta explicação.
A lista de operações, em baixo
| 1 |
Cada linha mostra o método, o nome e o caminho, como GET «Listar os registros DNS».
|
|
| 2 |
Clique na linha para a abrir. Aparece o endereço completo da operação, com um botão Copiar, e o botão Playground, que abre o painel de teste ali mesmo.
|
|
| 3 |
Por baixo vem a explicação da operação: autenticação, parâmetros, corpo do pedido, exemplos, respostas e erros. Veja como ler uma operação.
|
|
| Método |
O que costuma querer dizer |
| GET |
Ler: listar ou ver um item. Não altera nada. |
| POST |
Criar ou pedir uma ação: enviar um SMS, registrar um domínio, abrir um pedido de suporte. |
| PUT |
Alterar: mudar os nameservers, a renovação automática, um registro DNS. |
| DELETE |
Apagar: por exemplo, um registro DNS. |
Ir direto a uma operação
Cada operação tem um endereço próprio. O símbolo de link ao lado do nome copia-o; quem abrir esse endereço chega à página da área com a operação já aberta. É a forma mais rápida de dizer a um colega «é esta».
O filtro
Nas áreas com muitas operações aparece a caixa «Filtrar as operações desta área». Escreva parte do nome, do caminho ou do método: a lista encolhe enquanto escreve, e Enter abre a primeira que ficar.
|
As partes do caminho entre chavetas são valores seus. Em /v1/domains/{domain}/dns, o {domain} é o nome do seu domínio, por exemplo yourcompany.com.
|
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 cupom) Ver planos |
Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
