Como criar uma chave de API?
A API do TrainerStudio permite que outros programas trabalhem com a sua conta: criar clientes a partir do seu site ou do seu CRM, atribuir treinos a partir de uma automatização ou deixar que um agente de IA consulte os seus dados. Para que esses programas se identifiquem em seu nome, precisam de uma chave de API.
Este guia explica como criar, consultar e revogar chaves. Como as usar nos pedidos está explicado na documentação para programadores (em inglês).
1. Abra a secção Desenvolvedores
Vá a Seu app → Desenvolvedores no menu lateral (também está em Configuracoes → Desenvolvedores). Verá a lista das suas chaves e a ligação Ver a documentação da API.
Só quem tem permissão para gerir a faturação da conta (normalmente, o titular) vê esta secção.
2. Crie uma chave
- Clique em Criar Chave de API (em cima, à direita).
- Dê-lhe um nome que o ajude a reconhecê-la, por exemplo o sistema que a vai usar: «Integração CRM», «Zapier», «Agente de IA».
- Clique em Criar.
Abre-se a janela Chave de API Criada com a chave completa. Clique no botão de copiar à direita e cole-a no sistema que está a ligar. Depois clique em Pronto.
3. Consulte as suas chaves
A lista mostra cada chave com o Nome, o início da Chave (começa por ts_ak_) e a data de criação (Criado).
- Se precisar de copiar de novo uma chave, clique no ícone do olho (Revelar chave): abre-se a janela Chave de API com a chave completa e o botão de copiar.
- Crie uma chave por integração. Assim, se um dia deixar de usar uma ferramenta, pode revogar só a chave dela sem afetar as outras.
4. Revogue uma chave
Quando uma integração já não precisar dela, ou se achar que mais alguém a viu, clique no ícone do caixote do lixo dessa chave. Na janela Revogar Chave de API, confirme com Revogar.
A revogação é imediata: qualquer integração que use essa chave deixa de funcionar no momento. Não se pode desfazer; se voltar a precisar, crie uma chave nova e atualize-a na integração.
O que convém saber
- Trate-a como uma palavra-passe. Quem tiver a chave pode trabalhar com os dados da sua conta. Não a partilhe por e-mail nem a publique em código visível.
- Pode revelá-la quando quiser. Por isso esta secção é sensível: não deixe a sessão aberta em computadores partilhados.
- Uma chave por integração, com um nome claro, para as revogar uma a uma.
- Algumas ações não se podem fazer com uma chave, como gerir as próprias chaves, a equipa ou eliminar a conta: fazem-se sempre a partir do painel. Os detalhes estão na documentação de autenticação (em inglês).
- Quer ligar o ChatGPT ou o Claude? Não precisa de uma chave: siga os guias específicos, que usam um início de sessão seguro.