Skip to main content
Os serviços da Malga são protegidos através de chaves de acesso. Você pode gerenciar suas chaves de acesso através do seu Dashboard. É importante armazenar suas chaves de maneira privada e segura, uma vez que elas possuem privilégios de alteração na sua conta. Não compartilhe suas chaves, não deixe elas fixadas no seu código e nem armazene elas no seu servidor de controle de versão. Recomendamos utilizar variáveis de ambiente secretas para deixar a chave disponível para sua aplicação.
A Autenticação para todas as chamadas da API é feita através de headers HTTP, sendo necessário informar seu identificador de cliente na Malga e a chave secreta de acesso.

Gestão de chaves

Sua conta tem dois tipos de chave:

Sub-keys

Sub-keys são chaves derivadas da chave secreta da sua conta, com escopo e tempo de validade limitados. Você gerencia as sub-keys integralmente pela API, sem abrir chamado com a Malga:
  • Criação: com escopos (scope) e tempo de validade em segundos (expires). Veja Criar sub-key.
  • Remoção: antes do fim da validade, para fazer uma rotação manual. Veja Remover sub-key.
Uma sub-key é usada como a chave secreta, no header X-Api-Key, mas só acessa os escopos dela e deixa de funcionar quando expira ou é removida.

Onde usar sub-keys

  • Aplicações back-end: dê a cada serviço ou time uma sub-key só com os escopos de que ele precisa, em vez de compartilhar a chave secreta. Por exemplo, uma ferramenta interna que só estorna cobranças recebe uma sub-key com o escopo charges/*/void.
  • Aplicações client-side: no navegador ou em aplicativos, a sub-key fica exposta. Use sub-keys de curta duração (por exemplo, 900 segundos) e, de preferência, só com o escopo tokens, para tokenizar cartões. Crie uma sub-key nova a cada sessão de compra.

Criar uma sub-key

Faça a chamada no seu servidor, com a chave secreta:
Resposta 201:
Use o publicKey no header X-Api-Key:

Remover uma sub-key

A sub-key expira sozinha quando termina o tempo definido em expires. Se você quiser fazer uma rotação manual ou bloquear uma sub-key exposta, remova a sub-key antes do prazo, informando o publicKey dela na rota:
A resposta de sucesso é 200, sem corpo. Depois disso, as chamadas com a sub-key removida são recusadas com 403.

Chave secreta

A Malga oferece suporte a duas chaves secretas ativas ao mesmo tempo. Para trocar a chave secreta, gere uma nova chave e mantenha a anterior ativa durante a transição. Assim, você migra a integração sem interromper as chamadas à API. Depois da migração, revogue a chave anterior. Hoje, a revogação da chave secreta é feita pelo suporte da Malga: abra um chamado pedindo a revogação. Não envie a chave secreta no chamado. Chamados urgentes, como o vazamento de uma chave, têm SLA contratual de resolução em até 2 horas, 24/7.