Criar e gerenciar chaves de acesso à API
- haritha.kothapalem (Unlicensed)
- sneha.tripathi
Este artigo descreve o processo para criar Chaves de acesso à API e como definir restrições de acesso à Chave da API para as várias funcionalidades do Criador de bot. As Chaves de acesso à API permitem aos sistemas externos acessar a plataforma Agente virtual Luma com a identificação e a autorização corretas.
Para acessar as Chaves de acesso à API, clique em Definições no painel de navegação esquerdo do Criador de bot, como mostrado abaixo.
A grade na página Chaves de acesso à API exibe a lista de Chaves de acesso à API existentes. Para criar uma nova Chave de acesso à API, execute as seguintes etapas:
- Clique em Criar chave da API.
- Insira o nome da nova chave. O nome da chave indica a integração ou o uso da chave.
- Selecione o Status da chave. Quando uma chave for definida como Inativa, o acesso de sistemas externos será negado.
- Clique em Avançar.
- Forneça as permissões necessárias na página Permissões. As permissões definem quais módulos ou funções o aplicativo de chamada pode usar com a chave. As permissões podem receber um alto nível como acesso a todos os componentes das Definições de tenant, Usuários, Bot ou Gerenciamento de habilidades. É possível haver uma restrição mais granular nessas entidades. Por exemplo, se desejar designar a Chave de acesso para gerenciar apenas Usuários, basta marcar a caixa de seleção Gerenciamento de usuários.
Importante
Após a criação da Chave de acesso à API, ela será mostrada apenas uma vez. Depois de fechar a janela pop-up, ela não será exibida novamente e não estará disponível na interface do usuário. Certifique-se de copiá-la e armazená-la seguramente para ser usada em outros aplicativos.
Usando a Chave de acesso à API no cabeçalho da solicitação de API
Os campos a seguir devem ser passados como Campos de cabeçalho na Solicitação de API.
- ID externa do tenant. Esta ID externa do tenant ajuda a identificar o tenant na plataforma da agente virtual. A ID do tenant contém 32 caracteres alfanuméricos, por exemplo, Luma-tenant-externalId: <19e8ce3e-dbdb-5ce0-9401-71ae207be52g > . A ID externa do tenant pode ser obtida na página Informações do tenant no menu Definições.
- Chave de acesso à API: essa chave ajuda a identificar e autorizar o aplicativo externo. A Chave de acesso à API contém 50 caracteres alfanuméricos, por exemplo: Luma-api-access-key: <A0k1wba7DWfCikyEfKgA8qrGUIwWMhxgjx0CsL5LRJtcXZT0aT>