Chaves API
Crie uma chave para que outra ferramenta possa ler os seus relatórios do Fullmetrix, guarde-a em segurança e revogue-a quando já não precisar dela.
Uma chave API é uma palavra-passe destinada a software. Permite que uma ferramenta externa leia os seus relatórios do Fullmetrix sem usar a sua conta pessoal. Vai precisar de uma para três usos.
- O conector do Looker Studio, para construir os seus próprios painéis Google.
- A API pública, para que um programador possa levar os seus números para outro software, uma folha de cálculo ou uma ferramenta de BI.
- O servidor MCP, para consultar os seus dados a partir de um assistente de IA compatível.
Uma chave dá acesso de leitura aos relatórios de toda a organização, todas as lojas incluídas. Não pode alterar as suas definições nem os seus dados.
Para gerir as suas chaves, clique em Definições na barra lateral e depois no separador Chaves API.
Criar uma chave
Abrir a criação de chave
Clique em Criar uma chave no canto superior direito do cartão Chaves API. A janela Criar uma chave API abre-se.
Dar um nome à chave
Em Nome da chave, escreva o nome da ferramenta que a vai usar, por exemplo "Looker Studio" ou "Folha de cálculo de gestão". Este nome diz-lhe que chave revogar mais tarde. Clique depois em Criar uma chave ou prima Enter.
Copiar a chave
A chave completa aparece, com a mensagem Copie esta chave agora. Não será mostrada novamente após fechar esta janela. Clique no ícone de copiar à direita da chave. A mensagem Chave copiada para a área de transferência confirma-o. Cole-a de imediato na ferramenta ou no seu gestor de palavras-passe.
Fechar a janela
Clique em Concluído. A chave aparece na tabela.
A chave só é mostrada uma vez
Não guardamos a chave de forma legível, por isso não lha podemos mostrar de novo. Se a perdeu, crie uma nova e revogue a antiga.
Todas as chaves começam por fmx_. Se a criação falhar, aparece a mensagem Falha ao criar a chave. Tente de novo um pouco mais tarde.
Ler a tabela de chaves
| Coluna | O que mostra |
|---|---|
| Nome | O nome que deu à chave |
| Prefixo | Os primeiros caracteres da chave, para a reconhecer numa ferramenta sem a mostrar por inteiro |
| Criada | A data de criação |
| Última utilização | A data da última chamada feita com esta chave ou um traço se nunca foi usada |
Enquanto não existir nenhuma chave, o cartão mostra Nenhuma chave API criada ainda.
A coluna Última utilização ajuda a fazer a limpeza. Uma chave sem uso há meses pertence muitas vezes a uma ferramenta abandonada. Revogue-a.
Revogar uma chave
Revogar uma chave desativa-a para sempre. Faça-o quando uma ferramenta deixar de ser usada, quando um prestador sair do seu projeto ou se achar que outra pessoa viu a chave.
Clicar em Revogar
Na linha da chave, clique em Revogar.
Confirmar
A janela Revogar chave API lembra que as integrações que usam esta chave deixarão de funcionar. Clique em Revogar para confirmar ou em Cancelar.
A mensagem Chave API revogada confirma-o. A linha fica na tabela com a etiqueta Revogada, como registo. A revogação é imediata e não pode ser anulada. Para voltar a ligar a ferramenta, crie uma nova chave.
Manter as suas chaves em segurança
Uma chave permite a alguém ler todos os seus números de vendas. Trate-a como uma palavra-passe.
- Crie uma chave por ferramenta, para poder cortar uma sem mexer nas outras.
- Nunca a envie em texto simples por email ou chat e nunca a cole numa página pública nem num código que os seus visitantes possam ver.
- Revogue-a assim que deixar de ser necessária.
Nunca lhe pediremos uma chave API por email ou por telefone.
Perguntas frequentes
Conferir
Adicione uma caixa de consentimento de marketing à página de checkout da sua loja e registe o acordo dos seus clientes para email, WhatsApp e SMS.
Conta e empresa
Perceba a diferença entre a sua conta, a sua empresa e as suas organizações, e saiba onde gerir o seu perfil, a sua equipa e a sua subscrição.