Como cadastrar um Token de API?

Os tokens de API permitem que sistemas externos se comuniquem com a Apresenta.me de forma segura e automatizada. Com um token, você pode integrar ferramentas, scripts ou plataformas parceiras sem precisar compartilhar suas credenciais de acesso.

No dia a dia, esse recurso é útil para equipes de tecnologia ou parceiros que precisam consultar, enviar ou atualizar dados no sistema por meio de integrações personalizadas. Cada token é vinculado a um grupo de usuário, o que define quais operações aquela integração pode realizar.

Para criar ou remover tokens, você precisa ter permissão de cadastro e exclusão em equipes de usuários. Se precisar de um token com acesso total ao sistema, é necessário criar um grupo de usuário do tipo API com permissões completas e vinculá-lo ao token.

Rotina: Configurações > Integrações > Tokens de API

1. Navegação no módulo

Este GIF mostra o caminho de acesso até a tela de listagem de tokens de API.

2. Como funciona

A tela principal exibe a lista de todos os tokens cadastrados no sistema. Para cada token, você visualiza a descrição, a data de expiração, o valor do token, o grupo de usuário vinculado e a data de criação. Quando não há nenhum token cadastrado, a mensagem "Nenhum registro foi encontrado" é exibida.

Na parte superior da tela, você encontra os seguintes botões:

• Buscar: filtra os tokens pelo texto digitado ou pela data de atualização.
• Cadastrar: abre o formulário para criar um novo token.
• Remover: exclui o token selecionado.
• Documentação: abre a documentação técnica da API da Apresenta.me.
• Mostrar Token: revela o valor do token na listagem.
• Gerar novamente: cria um novo valor para o token selecionado.

A documentação completa dos recursos disponíveis na API pode ser acessada diretamente em: https://api.apresenta.me/docs

3. Cadastrando um novo token

Ao clicar em Cadastrar, uma janela é aberta com o formulário de criação do token. Preencha os campos disponíveis e confirme para gerar o token.

Campo	Descrição	Obrigatório
Descrição	Nome identificador do token. Use um nome que indique para qual integração ou sistema esse token será usado, como "Integração Portal X" ou "Script de Importação".	Sim

O token gerado pelo sistema é exibido apenas uma vez após o cadastro. Copie e guarde o valor em local seguro antes de fechar a janela. Caso perca o token, utilize o botão Gerar novamente para criar um novo valor, o que invalida o anterior.

4. Configurando o nível de acesso do token

O token em si não define o que a integração pode ou não fazer. Quem define isso é o grupo de usuário vinculado a ele. Portanto, antes de cadastrar um token, verifique se já existe um grupo de usuário do tipo API configurado com as permissões adequadas.

Se você precisar de um token com acesso total ao sistema, siga este caminho:

1. Acesse o módulo de equipes de usuários (ConfiguraçõesAdministrador >> CadastrosUsuários Gerais)>> Grupo de Usuários) e crie um novo grupo.
2. Defina o tipo do grupo como API.
3. Conceda permissão total a esse grupo.
4. Ao cadastrar o token, vincule-o a esse grupo.

Um token vinculado a um grupo com permissão total permite que qualquer sistema que o utilize realize leitura e escrita em todos os dados da plataforma. Crie esse tipo de token somente quando estritamente necessário e mantenha o valor em sigilo absoluto.

5. Listagem após o cadastro

Após salvar, o novo token aparece na listagem com sua descrição, grupo vinculado e data de criação. Para visualizar o valor do token a qualquer momento, selecione o registro e clique em Mostrar Token.

Boa prática: crie um token separado para cada integração. Assim, se uma integração for desativada ou comprometida, você pode remover apenas o token dela sem afetar as demais.

6. Perguntas frequentes

Onde encontro a lista de recursos disponíveis para integração via API?
A documentação completa está disponível em https://api.apresenta.me/docs. Lá você encontra todos os recursos, parâmetros e exemplos de uso.

O que acontece se eu clicar em "Gerar novamente" para um token que já está em uso?
Um novo valor é gerado e o valor anterior deixa de funcionar imediatamente. Qualquer sistema que utilizava o token antigo precisará ser atualizado com o novo valor.

Como faço para que meu token tenha acesso total ao sistema?
Você precisa criar um grupo de usuário do tipo API com permissão total e vincular esse grupo ao token no momento do cadastro. Sem essa configuração, o token terá apenas as permissões atribuídas ao grupo vinculado.

Posso ter mais de um token cadastrado ao mesmo tempo?
Sim. Você pode cadastrar quantos tokens forem necessários. O recomendado é criar um token por integração para facilitar o controle e a revogação individual de acessos.

Quem pode criar ou excluir tokens de API?
Apenas usuários com permissão de cadastro e exclusão em equipes de usuários conseguem gerenciar tokens. Se o botão "Cadastrar" não aparecer para você, verifique com o administrador do sistema se sua equipe possui essa permissão.