Pular para o conteúdo principal

Como Gerenciar e Criar Chaves de Acesso (API-KEY) no Blip

  • Atualizado

  1. Resumo

  2. Como criar uma nova chave de acesso

  3. Tipos de Autenticação

  4. Regras da Chave Padrão e Configuração HTTP

  5. Exclusão de chave de acesso

  6. Melhores Práticas de Segurança 

 

Resumo

O objetivo desta documentação é instruir os usuários sobre o processo completo de gestão das chaves de acesso (API-Key) na plataforma. Este artigo detalha a criação de novas chaves, a identificação dos tipos de autenticação (HTTP e SDK), a configuração da chave padrão, o processo de exclusão e as melhores práticas de segurança para a manutenção das credenciais 

Antes de começar

Para que você possa executar os procedimentos a seguir, certifique-se de que os seguintes requisitos sejam atendidos:

  • Apenas os usuários administradores do chatbot terão acesso a essa funcionalidade.

  • A criação de chaves de acesso possui um limite máximo de 3 chaves ativas por vez no bot.

  • Para que o chatbot funcione corretamente, é obrigatório possuir uma chave de acesso padrão. Ao criar um novo chatbot, essa chave padrão é gerada automaticamente.

 

Como criar uma nova chave de acesso 

Siga os passos abaixo detalhadamente para criar uma nova chave Authorization (API-Key) no seu bot: 

  1. Acesse o portal blip.ai e selecione o bot desejado;

  2. Após a interface carregar, clique sobre o nome de seu bot e selecione Configurações;

  3. Em seguida, selecione Chaves de acesso;

  4. Clique no botão Nova chave;

  5. No campo ‘Nome’, adicione um nome à sua escolha para identificar a nova chave;

  6. Selecione ‘Criar’;

  7. Após clicar no botão criar, será apresentada uma nova tela que irá exibir as informações da nova chave gerada;

  8. Nesta tela será possível verificar a sua nova chave no formato HTTP ou SDK. A chave de acesso é exibida apenas uma vez no momento da criação:

  1. Guarde estas informações em um local seguro, pois você não conseguirá consultá-las ou recuperá-las posteriormente por questões de segurança. Nunca compartilhe a sua chave de forma desprotegida;

  2. Após a finalização, uma referência a essa chave será exibida na tela principal de gerenciamento de chaves, permitindo que você consulte o ID ou consiga remover a chave selecionando o ícone da lixeira:


 

Tipos de Autenticação

Ao gerar as credenciais, você notará dois formatos distintos disponíveis:

  • Formato SDK: É utilizado para projetos com integração por SDK. Exemplos incluem Blip C# SDK, Blip Javascript SDK, Blip Python SDK ou Lime SDK.

  • Formato HTTP: É utilizado no header (Authorization) de uma requisição HTTP, como em integrações ou requisições HTTP realizadas diretamente ao Blip.

Para aprofundar o conhecimento sobre os tipos de autenticação (SDK e HTTP), acesse a documentação técnica em https://docs.blip.ai/#authentication 

 

Regras da Chave Padrão e Configuração HTTP

  • Chave Padrão: Uma chave marcada como padrão não poderá ser excluída e sua exclusão não é permitida diretamente. Para alterar a chave padrão, realize o processo de criação de uma nova chave. Assim, a última chave gerada irá se tornar a padrão automaticamente.

  • Configuração HTTP: Para alterar a configuração HTTP do bot na plataforma, será necessário informar a sua chave SDK. Essa exigência aumenta a segurança de quem poderá alterar essa informação sensível do seu chatbot.

 

Exclusão de chave de acesso

Antes de realizar o processo de exclusão, garanta que não exista nenhuma integração com utilizando a chave que você deseja deletar. A chave não pode estar em uso em nenhuma integração para ser apagada. 

Caso todas as chaves estejam em uso e você deseje apagá-las, será necessário primeiramente criar uma nova chave, atualizar todas as integrações externas para utilizá-la e, somente depois, excluir as chaves antigas.

Para excluir uma chave, siga os passos:

  1. Na tela de gerenciamento de chaves, identifique a credencial que não está em uso e clique no ícone da lixeira ao lado dela.

  2. O sistema solicitará uma verificação de segurança. Confirme a exclusão clicando no botão Excluir.

  3. Uma mensagem de "Chave excluída com sucesso" será exibida na interface, concluindo formalmente o processo de exclusão.


 

Melhores Práticas de Segurança

Para garantir a integridade do seu chatbot, siga rigorosamente estas orientações de segurança:

  • Troque periodicamente a chave de segurança: Recomendamos como segurança a alteração da chave de acesso periodicamente (por exemplo, a cada 6 meses). Como a chave não expira, se ela for obtida de forma indevida, poderá ser utilizada indevidamente por tempo indeterminado até que ela seja desativada na plataforma.

  • Guarda da chave em local seguro: Não guarde a chave de acesso em um local público. Guarde a chave gerada em um local seguro, como um cofre de senhas ou um gerenciamento de acesso privilegiado e, de preferência, em sistemas que possuam gestão de acesso à informação salva.

  • Compartilhamento da chave de acesso: Apenas realize essa ação se você confia integralmente na aplicação ou pessoa com quem irá compartilhar a informação. Ao compartilhar a chave de acesso, utilize uma forma segura de transitar essas informações, como um cofre de senhas ou um gerenciamento de acesso privilegiado com gestão de acesso.

  • Não deixe a chave em código: Não deixe a chave de acesso diretamente no código de sua aplicação. Você deve manter os segredos separados do seu código, armazenando-os, por exemplo, em arquivos de configurações específicos ou em variáveis de ambiente.

 

Precisa de mais ajuda? Explore nossos conteúdos na Blip Academy ou Blip Community, assista a tutoriais no nosso canal do YouTube ou tire suas dúvidas em nosso canal de atendimento 😃

Artigos relacionados