Uma chave de API permite que o seu próprio software comunique com a sua plataforma através da REST API, por exemplo para ler membros, inscrever alguém num curso ou ligar um site WordPress. Cada chave é uma palavra-passe secreta para um programa, por isso decide por chave o que pode fazer e pode substituí-la ou eliminá-la a qualquer momento.
Quem pode gerir chaves de API
API encontra-se no bloco Integrações e API do menu de configurações. A sua função precisa de Gerenciar chaves de API além de Atualizar configurações da plataforma. Esta permissão nunca está disponível para uma função personalizada, por isso só as funções integradas Proprietário e Administrador podem trabalhar aqui. A mesma permissão dá também acesso a Apps de OAuth e Login único.
O acesso à API depende do seu plano. Se o seu plano não o incluir, a página mostra "O acesso à API está incluído em todos os planos pagos. Mude de plano para criar chaves de API." juntamente com Alterar plano, e Nova chave de API fica desativado. As chaves que já existem são recusadas pela API até o plano voltar a incluí-lo.
Criar uma chave
Clique em Nova chave de API. Abre-se a janela Criar chave de API.
- Introduza um Nome da chave que lhe diga mais tarde quem usa a chave, por exemplo a ferramenta ou o site a que pertence. O nome é obrigatório.
- Decida o que a chave pode fazer. Uma chave nova começa com acesso total, por isso todas as permissões estão selecionadas.
- Clique em Criar.
Para restringir a chave, clique em Limitar a permissões específicas. Todas as permissões são desmarcadas e escolhe as de que precisa. As permissões estão agrupadas por área, como Membros, Grupos, Cursos ou Pagamentos, e cada área lista ações como Ver ou Gerenciar com uma breve descrição. Selecionar tudo e Desmarcar tudo alternam uma área inteira de uma só vez. Um contador mostra quantas permissões a chave tem. Uma chave precisa de pelo menos uma permissão, e Redefinir para acesso total volta a selecioná-las todas.
Depois de clicar em Criar, a janela Sua nova chave de API mostra a chave completa uma única vez. Copie-a e guarde-a num local seguro. Depois disso, a lista mostra apenas os últimos quatro caracteres, e ninguém consegue voltar a mostrar a chave completa.
Usar uma chave
A caixa Documentação da API por cima da lista mostra o URL base da API com um botão de copiar, e Abrir documentação leva à referência interativa com todos os endpoints.
Envie a chave em cada pedido, como Bearer token no cabeçalho
Authorization ou no cabeçalho X-Api-Key. As chaves começam por mak_.
Um pedido que precise de uma permissão que a chave não tem é recusado.
Uma chave está associada ao membro da equipa que a criou. Se essa pessoa deixar de pertencer ao seu espaço de trabalho, a chave deixa de funcionar, por isso crie as chaves para ligações de longa duração com uma conta que se mantenha.
A lista mostra cada chave com Nome, Chave, Último uso e Criado. Último uso é atualizado no máximo uma vez por minuto, o que basta para ver se uma chave ainda está em uso.
Alterar, rodar e eliminar uma chave
Clique numa chave da lista, ou use Editar, o ícone de lápis na sua linha, para alterar o nome ou as permissões. As alterações entram em vigor com Salvar.
Se uma chave puder ter sido exposta, rode-a. Rotacionar chave na mesma janela pergunta: "Rotacionar esta chave? O segredo antigo deixará de funcionar imediatamente e as integrações externas precisarão do novo." Depois de confirmar, a nova chave aparece uma única vez em Sua nova chave de API. O nome e as permissões mantêm-se, e Último uso recomeça do zero. Introduza a nova chave em todas as ferramentas que usavam a antiga.
Para remover uma chave, use Excluir, o ícone do caixote do lixo na sua linha, ou Excluir na janela aberta, e confirme. A partir daí, todas as ferramentas que ainda a usam são recusadas.
Apps OAuth, login único e webhooks
Colar uma chave não é a única forma de ligar:
- Apps de OAuth permitem que outras MemberAreas liguem o seu software por OAuth em vez de uma chave de API colada.
- Login único inicia a sessão dos membros a partir de outro sistema. Está descrito em Login, registo e SSO.
- Os webhooks para eventos de membros e de pagamentos têm uma página própria em Configurações > Webhooks, que aparece assim que os Pagamentos estão ativos.