Acesso à API

Visão geral

A OpenAPI do Data Service permite que você gerencie os recursos do UiPath^® Data Service de um aplicativo externo de sua escolha, permitindo que você autorize o aplicativo externo sem compartilhar qualquer credencial por meio da estrutura de autorização OAuth 2.0.

Permissões de API

Para usar a OpenAPI do Data Service, você precisa conceder permissões de API ao aplicativo externo. Essas permissões de API são conhecidas como escopos, e há três tipos para o Data Service:

• DataService.Schema.Read - esse Escopo do Usuário permite que seu aplicativo externo leia o esquema do Data Service do seu tenant, e depende das permissões do usuário.
• DataService.Data.Read — esse Escopo do Usuário permite que seu aplicativo externo leia os dados do Data Service do seu tenant, e depende das permissões do usuário.
• DataService.Data.Write — esse Escopo do Usuário permite que seu aplicativo externo edite os dados do Data Service do seu tenant excluindo, atualizando ou criando novos dados, e depende das permissões do usuário.

Saiba mais sobre as funções e permissões do usuário no Data Service.

Baixar a especificação do OpenAPI

Depois de definir as permissões para seu aplicativo externo e usuários, baixe a especificação da OpenAPI dos dados do Data Service do seu tenant:

• Na página Data Service clique em Acesso à API e selecione Baixar arquivo da OpenAPI (JSON).

Essa operação baixa as especificações da OpenAPI 3.0 de suas entidades do Data Service do tenant, no formato JSON.

Clicar em Copiar link da OpenAPI copia o endpoint da API que gera a especificação da OpenAPI do Data Service do tenant.

Autorizando as chamadas de API

Para acessar os recursos com escopo de usuário do Data Service, autorize seu aplicativo externo com um dos seguintes métodos:

• Código de autorização (para apps externos confidenciais)

• Código de autorização com o PCKE (para apps externos não confidenciais)

Pontos de extremidade da API

A estrutura de autorização OAuth2.0 ajuda você a gerar um token de acesso que permite que seu aplicativo externo faça chamadas da API REST para pontos de extremidade do Data Service, por um tempo limitado (uma hora).

Um endpoint da API do Data Service tem a seguinte sintaxe:

• Método HTTP + BaseURL + A categoria do recurso + A entidade do Data Service + A operação + Variáveis de caminho e parâmetros de consulta

  
  

  

  
  

  Exemplo de entidade do Data Service

  Para descrever cada corpo de solicitação/resposta da API, usamos os campos de entidade das Olimpíadas criados no Data Service. Embora estejamos documentando o ponto de extremidade genérico, como Get Entity Records, o seu ponto de extremidade deve conter o nome exato da sua entidade (por exemplo, Get Olympics Records). Os corpos de resposta e solicitação incluem todos os campos da sua entidade, replicando a sua estrutura.
  
  

  

  
  

  Além disso, vamos usar o guia da API do Data Service para nos aprofundar em cada ponto de extremidade e descobrir como você pode fazer bom uso dele.

Acesso a recursos do Data Service usando aplicativos externos

Configurando acesso refinado para apps externos

Apps externos usam suas próprias credenciais de cliente para acessar recursos do Data Service em vez de representar um usuário.

Quando um aplicativo externo deseja executar uma ação dentro de uma entidade, o Data Service verifica se o aplicativo tem as permissões necessárias para acessar os recursos correspondentes. Como nenhum usuário está envolvido na autenticação, a solicitação de qualquer recurso gera um token de acesso que verifica as atribuições que seu aplicativo tem nos níveis de tenant e entidade. Somente após uma validação bem-sucedida, o aplicativo externo obtém acesso aos recursos para os quais recebeu permissões.

Criação de aplicativos externos

Como administrador, siga estas etapas para criar um aplicativo externo e configurá-lo para acessar recursos do Data Service:

1. Em sua organização, navegue até Admin > Aplicativos externos. A página Aplicativos externos é exibida.

2. Clique em Adicionar Aplicativo:

   1. Forneça um nome para seu aplicativo externo.

   2. Selecione o tipo para seu aplicativo externo.

   3. Clique em Adicionar. Seu aplicativo externo é exibido na lista Aplicativos externos .

Diga algo sobre o escopo dataService.default Para aplicativos confidenciais que receberam funções personalizadas do Data Service, você precisa solicitar o escopo DataService.Default . Esse escopo usa um token de acesso para verificar as atribuições que seu aplicativo tem nos níveis de tenant e entidade. Somente após uma validação bem-sucedida, o aplicativo externo pode acessar os recursos aos quais recebeu acesso.

Adicionando apps externos a um tenant

Como administrador do Data Service, siga estas etapas para conceder acesso de um app externo a todas as entidades no tenant selecionado:

1. Na sua instância do Data Service, navegue até a página Gerenciar acesso .

   

2. Na página Gerenciar acesso , clique no botão Atribuir funções .

3. No painel Atribuir funções :

   1. No campo Adicionar nomes , digite o nome do seu aplicativo externo e, em seguida, selecione-o na lista.

   2. Na lista Selecionar funções , selecione a função personalizada criada anteriormente e a função Data Reader . Você pode selecionar outras funções que deseja atribuir ao seu aplicativo externo, mas o Data Reader é uma seleção obrigatória.

   3. Clique em Salvar. Seu aplicativo externo é exibido na lista da guia Atribuir funções .

      

Adicionando apps externos a uma entidade

Como administrador do Data Service, siga estas etapas para gerenciar o acesso de um aplicativo externo a entidades específicas:

1. Na sua instância do Data Service, navegue até a página Gerenciar acesso .

   

2. Na página Gerenciar acesso , clique no botão Criar função .

3. No painel Criar Função :

   1. Forneça um nome para a função personalizada.

   2. Assign the desired administrative permissions.

   3. Na seção Permissões de acesso aos dados , clique em Adicionar entidade, selecione a entidade desejada e, em seguida, selecione as permissões que o aplicativo externo pode ter dentro dessa entidade.

   4. Clique em Salvar. A função personalizada para seu aplicativo externo é exibida na lista da guia Funções .