A resposta curta: as chaves criam-se na página API do My MozOut. Escolhe um nome, o modo (Sandbox ou Produção), as permissões, a validade e, se quiser, uma lista de IPs e um limite de gastos. Confirma com a sua senha e com um código de 6 dígitos que recebe por e-mail. A chave aparece uma única vez: copie-a logo.
Quem pode criar
O dono de uma conta com um serviço ou um domínio activo. Cada conta pode ter até 20 chaves, cada uma com o seu nome. Uma chave nunca cria outra chave: só se criam na página API.
O que escolhe ao criar
| Campo |
O que é |
Conselho |
| Nome |
Para reconhecer a chave mais tarde. |
Use o nome do programa, por exemplo «site da empresa» ou «script de DNS». |
| Modo |
Sandbox (sandbox_) ou Produção (prod_). |
Comece em Sandbox. Veja Sandbox ou Produção. |
| Permissões |
O que a chave pode fazer, por área, com leitura e escrita separadas. |
Só as de que o programa precisa. Veja as permissões por área. |
| Validade |
30, 90 ou 365 dias, ou sem validade. A predefinida é 90 dias. |
Quanto mais curta, menor o estrago se a chave escapar. |
| Lista de IPs |
Opcional. Se a preencher, a chave só funciona a partir desses endereços. |
Use-a se o programa corre num servidor com IP fixo. |
| Limite de gastos |
O valor máximo que a chave pode gastar em 30 dias, na moeda da conta. |
Deixe a 0 se a chave não precisa de comprar nem pagar. Veja o limite de gastos. |
Passo a passo
| 2 |
Dê um nome à chave e escolha o modo. Para começar, escolha Sandbox.
|
|
| 3 |
Marque as permissões e a validade e, se fizer sentido, a lista de IPs e o limite de gastos.
|
|
| 4 |
Confirme com a sua senha actual e com o código de 6 dígitos enviado para o seu e-mail. O código vale 10 minutos e tem 5 tentativas. Quem entra com Google ou Facebook e não tem senha usável passa só pelo código.
|
|
| 5 |
Copie a chave e guarde-a num lugar seguro. Depois de criada, recebe também um e-mail de aviso.
|
|
|
A chave só se vê uma vez. Guardamos apenas um resumo dela (o hash) e os 4 últimos caracteres, por isso nem nós a conseguimos recuperar. Se a perder, revogue-a e crie outra.
|
Como se usa a chave
A chave começa por sandbox_ ou prod_, seguida de 43 caracteres aleatórios. Vai em todos os pedidos, no cabeçalho Authorization. A API não aceita a chave no endereço e só responde por HTTPS. Guarde-a numa variável de ambiente, fora do código:
export RLX_API_KEY="sandbox_..."
curl https://api.mozout.com/v1/token -H "Authorization: Bearer $RLX_API_KEY"
A resposta de GET /v1/token confirma que a chave funciona e mostra o modo, as permissões, a lista de IPs, a validade, os pedidos que restam neste minuto e o limite de gastos. A chave em si nunca volta numa resposta. Para chamar a API a partir do PHP, veja chamar uma API web com o cURL.
|
A chave é para o servidor, não para o navegador. Os navegadores só conseguem chamar a API a partir da própria documentação, por isso uma página do seu site não a pode usar directamente: o pedido tem de sair do seu servidor. Se tentou e apareceu um erro de CORS, é isso: veja o erro de CORS.
|
|
Pronto para criar a primeira chave? Comece por uma chave Sandbox, só com as permissões de que precisa.
Criar uma chave
|
PRODUTO RECOMENDADO Hospedagem de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 5.940,00 Kz/mês (plano de 3 anos, com cupão) Ver planos |
Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
