Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
A resposta curta: cada área da API tem duas permissões, :read para ler e :write para alterar, por exemplo dns:read e dns:write. A chave só faz o que lhe deu ao criá-la. Se lhe faltar a permissão que a operação pede, a API responde 403 com o código insufficient_scope.
As áreas e o seu estado
| Área | Permissões | Estado |
| Conta | account:read, account:write | Leitura disponível; a escrita ainda não tem operações |
| Catálogo | catalog:read, catalog:write | Leitura disponível; a escrita ainda não tem operações |
| Domínios | domains:read, domains:write | Disponível |
| DNS | dns:read, dns:write | Disponível |
| Alojamento | hosting:read, hosting:write | Disponível |
| email:read, email:write | Disponível | |
| WordPress | wordpress:read, wordpress:write | Em breve |
| Servidores VPS | vps:read, vps:write | Disponível |
| Facturação | billing:read, billing:write | Disponível |
| Suporte | support:read, support:write | Disponível |
| Produtos extra | extras:read, extras:write | Disponível |
| Revenda | reseller:read, reseller:write | Leitura disponível; a escrita ainda não tem operações |
| SMS | sms:read, sms:write | Disponível |
| Avisos automáticos | webhooks:read, webhooks:write | Em breve |
Pode marcar já as áreas «Em breve», mas só terão efeito quando as operações existirem.
Que permissão pede cada tarefa
| Quer... | A chave precisa de |
| Ver os domínios e os nameservers | domains:read |
| Mudar nameservers, bloqueio ou renovação automática | domains:write |
| Registar, renovar ou transferir um domínio | domains:write e billing:purchase |
| Criar, alterar ou apagar registos DNS | dns:write |
| Ver a lista de serviços (alojamento e servidores) | hosting:read |
| Criar uma base de dados ou um subdomínio | hosting:write |
| Criar caixas de e-mail ou reencaminhadores | email:write |
| Ver e reiniciar um VPS | vps:read e vps:write |
| Ver facturas, encomendas e cotações | billing:read |
| Pagar uma factura com o saldo | billing:pay |
| Abrir e responder a pedidos de suporte | support:write |
| Enviar SMS | sms:write |
| Uma armadilha conhecida: a lista de serviços, GET /v1/services, usa hosting:read mesmo para servidores. As operações próprias dos servidores, essas, usam vps:read. Um programa que gere VPS precisa normalmente das duas. |
O que não precisa de permissão de área
GET /v1/ping e GET /v1/openapi.json nem precisam de chave. GET /v1/token e GET /v1/limits funcionam com qualquer chave válida, e são a forma mais rápida de confirmar que permissões a chave tem.
Faltou uma permissão: e agora?
O conselho da própria API para insufficient_scope é criar uma chave com essa permissão. Faça-o na página API do My MozOut, troque a chave no programa e revogue a antiga, como explicamos em cuidar das suas chaves.
| Há ainda um grupo de permissões à parte, desligadas por omissão, para o que pode custar dinheiro ou dar acesso total: pagar, comprar, cancelar, reinstalar um VPS, entrar no cPanel. Estão em permissões sensíveis e limite de gastos. Regra geral: prefira :read sempre que o programa só lê. |
|
Vai criar uma chave? Marque só as áreas de que o programa precisa, e só a escrita onde ela é mesmo necessária. Criar uma chave |
PRODUTO RECOMENDADO Alojamento de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 5,94 €/mês (plano de 3 anos, com cupão) Ver planos |
