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.

Learn how to register the external application in UiPath^® Automation Suite.

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

Com seu aplicativo externo e o conjunto de permissões do usuário definido, é hora de baixar a especificação da OpenAPI dos dados do Data Service do seu tenant. Faça isso navegando até o menu superior direito na guia Data Service do tenant > Acesso de API > Baixar arquivo da OpenAPI (JSON).

Isso lhe fornecerá as especificações da OpenAPI 3.0 das entidades do Data Service do seu 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).

Para continuar chamando as APIs, você precisa gerar um novo token de acesso ou solicitar um token de atualização.

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.