Pular para o conteúdo principal

Gerenciamento de Chaves API

Aprenda como gerar, gerenciar e monitorar suas chaves API da Intelliscreen no painel da sua conta.

Gerando uma Chave API​

Para gerar sua chave API:

  1. Faça login na sua conta Intelliscreen
  2. Navegue até a visualização da sua conta

Processo de Geração de Chave API

  1. Clique na aba "API Key"

Processo de Geração de Chave API

  1. Clique no botão "Generate" para criar uma nova chave API
  2. Use o botão "Copy" para copiar sua chave com segurança

Processo de Geração de Chave API

Processo passo a passo para gerar uma chave API no painel da sua conta

Regenerando sua Chave API​

Se você precisar regenerar sua chave API:

  1. Clique no botão regenerar localizado abaixo da sua chave API
  2. Confirme a regeneração

Importante: Regenerar sua chave API invalidará imediatamente a chave anterior. Qualquer aplicação que esteja usando a chave antiga parará de funcionar até ser atualizada com a nova chave.

Monitoramento do Uso da API​

Como visto na imagem anterior, fornecemos um registro abrangente de todo o uso da chave API, ajudando você a monitorar e depurar suas integrações.

Informações do Log de Uso​

Para cada chamada da API, o log inclui:

  • Timestamp: Quando a chamada da API foi feita
  • Endpoint: Qual endpoint da API foi acessado
  • Método HTTP: O método HTTP usado (GET, POST, PUT, etc.)
  • Status da Resposta: O código de status HTTP retornado

Benefícios do Monitoramento de Uso​

  • Depurar Problemas: Identificar solicitações com falha e resolver problemas
  • Monitorar Atividade: Rastrear padrões de uso da API e frequência
  • Segurança: Detectar uso não autorizado ou inesperado da API
  • Performance: Analisar tempos de resposta e otimizar sua integração

Melhores Práticas​

Segurança​

  • Limitar acesso: Compartilhe chaves API apenas com membros da equipe que precisem delas
  • Rotação regular: Considere regenerar chaves API periodicamente para maior segurança
  • Verificar logs regularmente: Revise seus logs de uso da API para garantir que tudo esteja funcionando conforme esperado

Solução de Problemas​

Problemas Comuns​

  • 401 Não Autorizado: Sua chave API pode ser inválida ou não estar formatada corretamente
  • 403 Proibido: Sua chave API pode não ter permissão para acessar o recurso solicitado
  • Chave não funciona após regeneração: Certifique-se de estar usando a nova chave, não a antiga

Obtendo Ajuda​

Se você encontrar problemas com sua chave API:

  1. Verifique os logs de uso para detalhes do erro
  2. Verifique se sua chave API está formatada corretamente em suas solicitações