A resposta curta: a documentação da API é o site onde explicamos, página a página, como ligar os seus programas à sua conta na MozOut: o seu site, o sistema de faturamento, uma aplicação ou um simples script. Tem guias, a referência de todas as operações, exemplos de código prontos a copiar e um Playground para experimentar pedidos no navegador. Lê-se sem conta e sem entrar em lado nenhum: abrir a documentação.
Para quem é
| Quem |
O que lá encontra |
| Programador ou agência |
As regras da API, a referência de cada operação, os exemplos em curl, PHP, Python e JavaScript, e a especificação OpenAPI para importar nas suas ferramentas. |
| Dono de uma empresa |
A lista «O que a API já faz», na página inicial, para saber o que pode ser automatizado antes de pedir um orçamento a um programador. |
| Equipe técnica que já usa a API |
As páginas de cada área, os códigos de erro, os limites e as operações que mostram o estado da chave. |
| Ferramentas de IA |
Uma versão em Markdown de cada página e um índice em texto simples, o arquivo llms.txt. |
O que é, e o que não é
A documentação fala da API: pedidos, respostas, chaves e permissões. Para usar os serviços pelo My MozOut, por exemplo criar uma caixa de e-mail, pagar uma fatura ou mudar os nameservers à mão, o lugar certo é esta Base de Conhecimento. As duas estão ligadas: no fim de cada página da documentação há uma caixa «Não encontrou o que procurava?» que leva à pesquisa e à Base de Conhecimento.
O que está na página inicial
| 1 |
Primeiros passos: confirmar que a API responde, criar uma chave no My MozOut e fazer o primeiro pedido com essa chave.
|
|
| 2 |
Comece aqui: cartões para Começar com a API, Autenticação e chaves, Permissões, Regras da API, a Referência e o Playground.
|
|
| 3 |
O que a API já faz: a lista das operações desta versão. A API está crescendo por fases, e a própria página avisa: o que não está na lista ainda não existe na API, e essas tarefas fazem-se no My MozOut.
|
|
| 4 |
Áreas da API: domínios, DNS, hospedagem, e-mail, servidores, SMS, Email Center, faturas e saldo, conta, catálogo, suporte, produtos extra, revenda e chave e estado.
|
|
Como lá chegar
| 1 |
Pelo site: a página da API tem o botão para abrir a documentação.
|
|
| 2 |
Diretamente: este link leva à página inicial; guarde-a nos favoritos.
|
|
| 3 |
Pela Base de Conhecimento: os artigos sobre a API, como este, ligam às páginas certas da documentação.
|
|
Do lado da documentação, o menu de cima leva de volta ao site, à Base de Conhecimento e ao My MozOut. A documentação existe em português e em inglês: veja onde está cada língua.
|
Ler a documentação é livre; usar a API pede uma chave. Para criar chaves precisa de uma conta na MozOut com um serviço ou um domínio activo. A chave cria-se no My MozOut, na página API, e nunca na documentação.
|
|
Quer ver o que a API já faz pela sua conta? A documentação está aberta a todos.
Abrir a documentação
|
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
