Acesso à API

Visão geral

Data Fabric / Data Service Open API permite que você gerencie recursos do UiPath^® Data Fabric / Data Service a partir de um aplicativo externo de sua escolha e faz isso permitindo que você autorizar o aplicativo externo sem compartilhar nenhuma credencial, por meio da estrutura de autorização do Oauth 2.0.

Saiba como registrar um aplicativo externo.

Permissões de API

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

• Data Fabric / Data Service.Schema.Read - este escopo do usuário permite que seu aplicativo externo leia o esquema do Data Fabric / Data Service do seu tenant e depende das permissões do usuário.
• Data Fabric / Data Service.Data.Read - este escopo do usuário permite que seu aplicativo externo leia os dados do Data Fabric / Data Service do seu tenant e depende das permissões do usuário.
• Data Fabric / Data Service.Data.Write - este escopo do usuário permite que seu aplicativo externo edite os dados do Data Fabric / 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 de usuário em Data Fabric/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 OpenAPI de seus dados do Data Fabric/Data Service:

• Na página Data Fabric / Data Service, selecione Acesso à API e, em seguida, selecione Baixar arquivo OpenAPI (JSON).

Esta operação baixa as especificações do OpenAPI 3.0 de suas entidades do Data Fabric/Data Service, no formato JSON.

Selecionar Copiar link OpenAPI copia o endpoint da API que gera a especificação OpenAPI do Data Fabric/Data Service do tenant.

Autorizando as chamadas de API

Autorize seu aplicativo externo para usar o Data Fabric/Data Service OpenAPI criando um token de acesso para seu aplicativo externo. Use o ID do aplicativo e o 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 apps 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 de API REST para pontos de extremidade do Data Fabric/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 ponto de extremidade de API do Data Fabric/Data Service tem a seguinte sintaxe:

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

  

Exemplo de entidade do Data Fabric/Data Service

Para descrever cada corpo de solicitação/resposta de API, estamos usando os campos da entidade Olimpíadas criados no Data Fabric/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 Data Fabric/Data Service para mergulhar em cada ponto de extremidade e descobrir como você pode colocá-lo em bom uso.