Acesso à API

Chame a API do Integration Service a partir de um aplicativo externo, usando a autorização do OAuth 2.0 e os escopos do Integration Service.

Visão geral

A API do Integration Service permite que você trabalhe com recursos do Integration Service de um aplicativo externo de sua escolha. Você autoriza o aplicativo por meio da estrutura do OAuth 2.0, para que um serviço ou script possa se autenticar por conta própria, em vez de depender de uma sessão de usuário conectada e sem compartilhar nenhuma credencial.

Use-a para chamar o Integration Service de um pipeline de CI/CD que publica ou implanta uma solução fazendo referência a um conector personalizado, ou de um aplicativo codificado ou agente que precisa criar ou gerenciar suas próprias conexões do Integration Service sem um usuário conectado.

O acesso é restrito aos escopos que você concede. Um aplicativo externo ou um usuário atuando por meio de um não pode exceder essas permissões. O acesso à API existente usando tokens de usuário permanece inalterado.

Saiba como registrar um aplicativo externo.

Permissões de API

Para chamar a API do Integration Service, você deve conceder permissões de API ao aplicativo externo. Essas permissões são conhecidas como escopos. Adicione-as no Automation Cloud em Admin > Aplicativos externos, adicionando Integration Service como um recurso.

Escopo	Permissões	Disponível como
IS.Connection.Read	Acesso de leitura para conexões.	Escopo do usuário
IS.Connectors.Read	Acesso de leitura a conectores, incluindo o download de um conector personalizado.	Escopo do usuário, escopo do aplicativo
IS.Connector.Export	Não usado. Nenhum ponto de extremidade exige esse escopo.	N/A

Importante:

IS.Connection.Read é apenas um escopo de usuário. Um aplicativo externo que autentica por conta própria, sem um usuário conectado, não pode ser concedido.

Os aplicativos não confidenciais podem receber apenas escopos de usuário. Para obter a diferença entre os tipos de aplicativos e entre usuário e escopos de aplicativos, consulte Autorização de aplicativos externos.

Autorizando as chamadas de API

Autorize seu aplicativo externo criando um token de acesso para ele. Use o ID do aplicativo e o Segredo do aplicativo gerados quando você registrou o aplicativo. O método de autorização depende do tipo do aplicativo, confidencial ou não confidencial.

Saiba mais sobre os métodos de autorização para apps externos.

Envie o token como um token de portador em suas solicitações. Um token é válido por uma hora. Para continuar chamando a API após isso, gere um novo token de acesso ou solicite um token de atualização.

Escopo da pasta

Um aplicativo externo deve segmentar uma única pasta em cada solicitação, usando o cabeçalho X-UIPATH-FolderKey e precisa da permissão Connections.View nessa pasta. As solicitações que omitem o cabeçalho e as solicitações que solicitam todas as pastas são rejeitadas.

Uma conexão que existe em uma pasta diferente da que você segmentou é relatada como não encontrada, em vez de proibida.

Endpoints disponíveis

O guia de API documenta atualmente esses pontos de extremidade:

• Obter conexões
• Obter conexão por ID
• Baixar conector personalizado

As respostas a um aplicativo externo omitem o proprietário da conexão, o ID da instância do elemento, o intervalo de pesquisa e o sinalizador traga-seu-próprio-aplicativo. A configuração de uma conexão é retornada apenas para chamadores que contêm o escopo de leitura de configuração, e valores secretos, como chaves de API e tokens OAuth nunca são retornados.

Para obter detalhes sobre cada ponto de extremidade, consulte o guia da API do Integration Service.