Introdução à API do Automation Hub

O recurso Open API permite que os usuários do UiPath Automation Hub acessem e manipulem os dados de seu tenant programaticamente. Com base no feedback recebido, bem como na estrutura da plataforma, concentramo-nos em entregar solicitações de API como nos exemplos abaixo:

Observação:

• A lista completa de chamadas de API pode ser encontrada na documentação do Swagger e do Postman .
• Alguns exemplos rápidos de como usar as chamadas de API podem ser encontrados em Exemplos de chamadas de API. Para uma experiência mais profunda ou para testar respostas específicas da API, use o ambiente do Swagger ou do Postman descrito nas Referências da API.

Avaliações personalizadas

• GET/idea-schema
• POST/idea-from-schema
• GET/automations/{automationId}/schema
• PATCH/automations/{automationId}

Ideias de Automação

• GET/automations
• GET/automations/collaborators
• DELETE/automations/{automationId}/collaborators
• POST/automations/{automationId}/collaborators
• GET/automations/{automationId}/documents
• POST/automations/{automationId}/documents
• GET/automations/{automationId}/components
• GET/questionnaire
• GET/cba
• PUT/automations/cba/{automationId}/project-plan-baseline
• POST/automationidea
• POST/coe-automationidea
• POST/processmining-idea
• POST/automations/{automationId}/media
• POST/automations/status
• POST/automations/{automationId}/tags
• PUT/automation/{automationId}/categories

Pipeline de Automação

• GET/automationpipeline

Usuários

• GET/users
• GET/roles
• POST/adduser
• POST/edituser

Inventário de Aplicativos

• GET/appinventory
• PUT/appinventory
• DELETE/appinventory/{applicationId}

Categorias

• GET/hierarchy
• PUT/categories

Components

• GET/components

Repositório de Automação

• GET/automation-store
• GET/automation-store/{automationId}/reviews

As chamadas de API refletem as ações que um usuário pode executar na interface do Automation Hub.

Para começar a fazer chamadas com as seguintes variáveis, acesse as opções da OpenAPI na plataforma do Automation Hub > Console de administração > Configuração da plataforma > Open API e gere seu token.

Variável	Valor
Token	O token gerado a partir da IU do Automation Hub.
URL	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
URL do lançamento atrasado	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
Obtenha via GET a estrutura de API de todas as ideias para Organizações de lançamento atrasado	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
Chave do Aplicativo	A chave do aplicativo gerada a partir da IU do Automation Hub.

Observação: {orgName} e {tenantName} são variáveis que se referem ao nome de sua organização e ao nome de seu tenant.

A próxima etapa é Consumir as APIs disponíveis.

Referências de API

A definição do Swagger da API do Automation Hub pode ser acessada diretamente adicionando os detalhes de autenticação na chave de autorização na chamada de solicitação chamada Cabeçalho.

https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Este guia foi criado para oferecer suporte à documentação do Swagger, fornecendo exemplos relevantes e fáceis de seguir.

Para usar a documentação do Swagger em Organizações de lançamento atrasado, use o seguinte link:

https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Se você preferir trabalhar com o Postman, crie um ambiente do Postman. Em seguida, consulte nossa coleção de APIs disponibilizada no Postman. A coleção pode ser importada clicando no botão Executar no Postman .