Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
API para Programadores
Gira domínios, alojamento, servidores, SMS e faturas a partir do seu próprio código.
- Início »
- API para Programadores
SMS para Empresas
Avisos, lembretes e campanhas por SMS para Moçambique e Angola, sem pacotes.
O que faz no My MozOut também o pode fazer a partir do seu código: registar domínios, mudar o DNS, criar caixas de e-mail, enviar SMS ou pagar faturas com o saldo.
Domínios, DNS, alojamento, e-mail, VPS, SMS e faturas num só endereço.
Na Sandbox, as consultas são reais e as alterações são simuladas, sem custo.
Cada chave só faz o que lhe permitir, por área, com a leitura e a escrita separadas.
Respostas sempre em JSON, com as mensagens na língua que o pedido indicar.
Cada operação tem exemplos e campos explicados, e o Playground deixa-o fazer pedidos de teste no navegador.
As operações estão organizadas por área. Cada chave recebe só as áreas de que precisa, para ler, para alterar ou para as duas coisas.
Registar, transferir e renovar.
Registos e cópias da zona.
Bases de dados, FTP, cron e SSL.
Caixas de correio e autenticação.
Ligar, reiniciar e reinstalar.
Enviar e consultar o histórico.
Consultar, descarregar e pagar.
Dados da conta e utilizadores.
Produtos, extensões e moedas.
Tickets, artigos e anúncios.
Ver e comprar produtos extra.
Programas e contas de revenda.
Revendedores, agências e programadores usam a API para automatizar, a partir do seu próprio código, o que fariam à mão no My MozOut.
Registe domínios, mude o DNS e crie caixas de e-mail para os seus clientes sem abrir o My MozOut. Veja também a revenda de alojamento.
Ligue o seu sistema de faturação ou o seu site: consulte e pague faturas com o saldo e envie SMS aos seus clientes.
Com scripts, ligue, reinicie ou reinstale um servidor VPS e mantenha os nameservers e o DNS sempre atualizados.
A autenticação faz-se só com uma chave API, enviada no cabeçalho Authorization. Cada chave tem as suas regras e pode ser revogada a qualquer momento.
Todas as operações seguem as mesmas regras: JSON, HTTPS, uma chave no cabeçalho e códigos de erro que não mudam.
code de erro que nunca muda.page e per_page, até 100 por página.X-RateLimit-Limit e X-RateLimit-Remaining.Accept-Language.# Lista de domínios
GET /v1/domains?page=1&per_page=10
200 OK
{
"data": [ ... ],
"meta": { "page": 1, "per_page": 10, "total": 3, "total_pages": 1 }
}
# Chave sem a permissão necessária
403 Forbidden
{
"error": {
"code": "insufficient_scope",
"message": "...",
"correlation_id": "..."
}
}
Comece em Sandbox, sem risco de alterar a conta nem de pagar alguma coisa, e passe para Produção quando o seu programa estiver pronto.
Na página API do My MozOut, escolha o nome, o modo Sandbox e as permissões.
Use o Playground ou o exemplo ao lado. As alterações são simuladas, sem custo.
Crie uma chave prod_ com as permissões mínimas. No pedido, só muda a chave.
curl https://api.mozout.com/v1/sms/messages \
-H "Authorization: Bearer sandbox_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 0f8fad5b-d9cb-469f-a165-70867728950e" \
-d '{"number": "+258841234567",
"text": "A sua encomenda está pronta."}'
Enviar um SMS com uma chave de Sandbox: o pedido é validado e a resposta vem em JSON, mas nada é enviado nem cobrado.
Idempotency-Key
As duas chaves usam o mesmo endereço e as mesmas operações. A diferença está no que acontece quando o pedido altera alguma coisa.
| Sandboxsandbox_ | Produçãoprod_ | |
|---|---|---|
| Lê os dados reais da conta | Sim | Sim |
| Alterações | Simuladas, com o cabeçalho X-API-Simulated: true | Reais |
| Cobranças | Nunca | Pagas com o saldo da conta |
| SMS | Validados, mas não enviados | Enviados e descontados no saldo de SMS |
| Endereço | api.mozout.com/v1 | O mesmo |
| Cabeçalho X-API-Mode | sandbox | production |
| Para que serve | Desenvolver e testar sem risco | O seu programa, já pronto |
Artigos para escolher, configurar e tirar o máximo deste serviço
A resposta curta: uma API é a forma combinada de um programa pedir coisas a outro. Em vez de uma pessoa abrir uma página e clicar, o seu site…
Ler o artigo
A resposta curta: se uma chave de API, um token ou o segredo de um webhook apareceu onde não devia (um repositório público, um ficheiro dentro do site, uma…
Ler o artigo
Para falar com uma API a partir do PHP usa-se o cURL: abre-se um pedido, envia-se, lê-se o código de estado (200, 401, 404…) e só depois se descodifica…
Ler o artigo
As perguntas mais frequentes sobre as chaves, os modos e os limites da API
Só com uma chave API, enviada em todos os pedidos no cabeçalho Authorization: Bearer. A API não aceita a chave no endereço e só responde por HTTPS.
O dono de uma conta com um serviço ou um domínio ativo, na página API do My MozOut. Cada conta pode ter até 20 chaves.
A chave só aparece uma vez, quando é criada, e não a conseguimos recuperar. Revogue-a na página API do My MozOut e crie uma nova.
Sim, com uma chave de Produção que tenha as permissões de domínios e de compras; o pagamento sai do saldo da conta. Alguns casos ficam no My MozOut, como os .mz e .ao com até 3 caracteres, os .ac.mz, .gov.mz e .mil.mz e as transferências de .mz e .ao. Veja os preços de domínio.
Sim. Ao criar a chave, indique a lista de IPs. Os pedidos feitos de outro endereço são recusados com o erro ip_not_allowed.
Uma chave sandbox_ lê os dados verdadeiros da conta, mas as alterações são simuladas e nunca são cobradas. Uma chave prod_ lê e altera a conta. O endereço é o mesmo: é a chave que decide.
Sim. A conta pode fazer até 300 pedidos por minuto, somando todas as chaves. Algumas operações, como os registos de domínios ou os pagamentos, têm limites próprios, explicados na documentação.
Num pedido POST, envie um código único no cabeçalho Idempotency-Key. Se a ligação cair e voltar a enviar o pedido com o mesmo código nas 24 horas seguintes, recebe a mesma resposta e nada é feito duas vezes.
Sim. Dê à chave as permissões de SMS e envie mensagens, consulte o saldo, o histórico e os modelos. Veja os preços na página do SMS.
Não. Uma chave nunca cria outras chaves, nunca muda a senha nem o e-mail da conta e nunca vê os dados dos cartões. As permissões mais sensíveis, como pagar ou reinstalar um VPS, vêm desligadas.
