Acesso à API

Visão geral

Data Service Open API allows you to manage UiPath^® Data Service resources from an external application of your choice, and does so by enabling you to authorize the external app without sharing any credentials, through the Oauth 2.0 authorization framework.

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

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:

On the Data Service page, click API Access, then select Download OpenAPI file (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

Autorize seu aplicativo externo para usar a OpenAPI do Data Service criando um token de acesso para seu aplicativo externo. Use o ID do Aplicativo e Segredo do Aplicativo que foram gerados no registro do aplicativo externo. 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 aplicativos externos.

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.