Chaves de API

Você usa chaves de API para estabelecer uma conexão entre a plataforma UiPath® e outros aplicativos externos a ela. Os aplicativos externos podem ser aplicativos de desktop UiPath ou aplicativos de terceiros.

As chaves de API estão disponíveis para vários serviços (produtos) da UiPath.

Orchestrator

Sobre o Acesso de API

Você pode visualizar as informações de acesso à API para cada um de seus serviços do Orchestrator existentes na página Admin > Tenant > Serviços.

Essas informações são necessárias para autenticação em seu serviço do Orchestrator na Automation Cloud por meio de chamadas de API.

Observação: se você não tiver acesso à página Administrador, que está disponível apenas para usuários com função de administrador da organização, você poderá obter informações de acesso à API na página Preferências da sua conta.

Importante:

Não se aplica ao Azure AD

Se as configurações de autenticação da sua organização estiverem definidas para usar uma integração de diretório, o botão Acesso à API não estará disponível e essas instruções não se aplicarão a você.

Nesse caso, você deve executar um dos seguintes procedimentos:

• saia do Automation Cloud e depois faça logon com uma conta UiPath® em vez de uma conta de diretório ou
• (recomendado) use o fluxo OAuth em vez disso.

Exibição de informações de acesso da API

Você pode exibir as informações de acesso à API para um serviço se você tiver a função de Administrador da organização ou se tiver sido designado para esse serviço.

1. Acesse Admin e selecione o tenant no painel à esquerda.
2. Clique em Serviços.

   A página Serviços é aberta, listando todos os serviços existentes para o tenant selecionado.

3. Clique em no cartão do Orchestrator e selecione Acesso da API:
   
   

   

   
   

   A janela Acesso à API é exibida com as seguintes informações específicas do serviço:

   • Chave do usuário - permite que você gere chaves de logon exclusivas para serem usadas por APIs ou aplicativos externos para fazer logon e executar ações em seu nome. Isso era conhecido anteriormente como seu token de atualização.
   • Nome lógico da conta — o nome da sua organização (por exemplo, myNewOrg).
   • Nome do tenant - nome de exibição do tenant.
   • ID do cliente - específico para o próprio aplicativo do Orchestrator, é o mesmo aplicativo para todos os usuários e serviços do Orchestrator em uma plataforma específica. Por exemplo: todos os serviços do Orchestrator no cloud.uipath.com têm o mesmo valor de ID do cliente.
4. Clique no ícone ao lado de cada campo para copiar seu valor.
   
   

   

   
   

Você pode usar as informações copiadas para consumir APIs de nuvem .

Revogando o acesso à API

Revogar o acesso cancela todas as chaves de usuário atribuídas anteriormente, quebrando assim todos os aplicativos que dependem de chaves de usuário atribuídas anteriormente. Uma nova chave de usuário é gerada automaticamente para o serviço do Orchestrator selecionado.

Você deve compartilhar a nova chave de usuário com todos os aplicativos afetados.

1. Acesse Admin e selecione o tenant no painel à esquerda.
2. Clique em Serviços.

   A página Serviços é aberta, listando todos os serviços existentes para o tenant selecionado.

3. Clique em no cartão do Orchestrator e selecione Acesso da API.

   A janela Acesso à API é aberta.

4. Clique em Revogar Acesso.

   Uma janela de confirmação se abre.

5. Clique em Revogar para confirmar sua ação.

   O valor da Chave de Usuário do serviço é revogado e a janela Tokens de Atualização Revogados é exibida.

6. Feche a janela Tokens de atualização revogados.
7. Copie e compartilhe a nova chave com os usuários que precisam dela.

Document Understanding

A chave de API para o Document Understanding está disponível na página Admin > Organização > Licenças > Robots e serviços:

A partir desse local, você pode:

• Copiar a chave para uso em aplicativos externos.

• Clique no ícone Atualizar para gerar uma nova chave.

  Importante: a geração de uma nova chave torna a antiga inválida. Quaisquer aplicativos externos que usavam a chave antiga não podem mais conectar-se ao Automation Cloud.

Para obter mais informações, consulte Chave de API na documentação do Document Understanding.

Computer Vision

A chave de API para o Computer Vision está disponível na página Admin > Organização > Licenças > Robots e serviços.

A partir desse local, você pode:

• Copiar a chave para uso em aplicativos externos.

• Clique no ícone Atualizar para gerar uma nova chave.

  Importante: a geração de uma nova chave torna a antiga inválida. Quaisquer aplicativos externos que usavam a chave antiga não podem mais conectar-se ao Automation Cloud.

Para obter mais informações, consulte Computer Vision .