Gerenciamento de fluxos de trabalho da API

Criação de fluxos de trabalho da API

Para criar uma solução de fluxo de trabalho de API:

1. Na sua organização do Automation Cloud™, abra o Studio Web.
2. Selecione Criar novo > fluxo de trabalho da API.

Definição de esquemas de entrada

Os fluxos de trabalho de API funcionam como as próprias APIs e podem exigir um esquema de entrada para definir os parâmetros de entrada esperados. O esquema de entrada especifica a estrutura de dados que um serviço externo deve fornecer ao acionar o fluxo de trabalho.

É possível configurar o esquema de entrada carregando um JSON ou definindo manualmente os parâmetros de entrada.

1. Em seu projeto de fluxo de trabalho de API, abra o painel Gerenciador de dados .
2. Selecione a guia Entrada .

   Para carregar um esquema JSON, siga a Etapa 3.

   Para definir manualmente os parâmetros de entrada, siga a Etapa 4.

3. Para carregar um esquema JSON com os parâmetros de entrada já definidos, selecione Gerar a partir da carga.
   1. Forneça o JSON com a entrada esperada.
   2. Selecione Gerar esquema.
   3. Revise o esquema gerado e adicione descrições às propriedades, se necessário.
4. Para definir manualmente os parâmetros de entrada, selecione Adicionar propriedade.
   1. Configure os detalhes da propriedade:
      • Nome— Defina a chave de propriedade
      • Tipo— Selecione de String, Número, Inteiro, Booleano, Objeto, Array, Data-hora, Data, Hora.
        Importante: se você estiver usando um Object ou um Array, defina as propriedades para os itens aninhados.
      • Obrigatório— Selecione esta caixa para marcar a propriedade como obrigatória.
   2. Repita a etapa até definir todos os parâmetros de entrada.

Definição de esquemas de saída

O esquema de saída define a estrutura dos dados retornados pelo fluxo de trabalho da API, garantindo que qualquer serviço que chamar o fluxo de trabalho entenda o formato de saída com antecedência. O esquema de saída pode incluir dados definidos explicitamente dentro do próprio esquema, como IDs ou valores fornecidos pelo usuário, bem como saídas geradas dinamicamente a partir de etapas do fluxo de trabalho, como respostas de API ou valores calculados.

Você pode configurar o esquema de saída carregando um JSON ou definindo manualmente os parâmetros de saída.

1. Em seu projeto de fluxo de trabalho de API, abra o painel Gerenciador de dados .
2. Selecione a aba Saída .

   Para carregar um esquema JSON, siga a Etapa 3.

   Para definir manualmente os parâmetros de saída, siga a Etapa 4.

3. Para carregar um esquema JSON com os parâmetros de saída já definidos, selecione Gerar a partir da carga.
   1. Forneça o JSON com a saída esperada.
   2. Selecione Gerar esquema.
   3. Revise o esquema gerado e adicione descrições às propriedades, se necessário.
4. Para definir manualmente os parâmetros de saída, selecione Adicionar propriedade.
   1. Configure os detalhes da propriedade:
      • Nome— Defina a chave de propriedade
      • Tipo— Selecione de String, Número, Inteiro, Booleano, Objeto, Array, Data-hora, Data, Hora.
        Importante: se você estiver usando um Object ou um Array, defina as propriedades para os itens aninhados.
      • Obrigatório— Selecione esta caixa para marcar a propriedade como obrigatória.
   2. Repita a etapa até definir todos os parâmetros de saída.

Uso do Editor de expressão

O Editor de expressão ajuda você a acessar, avaliar e manipular dados dentro de fluxos de trabalho de API. Use-o para criar lógica condicional, configurar campos de atividades ou escrever atividades JavaScript.

Layout do editor de expressão

O layout do Editor de expressão contém os seguintes painéis:

Painel	Description
Entrada	O painel principal é o painel de entrada, onde você escreve suas expressões JavaScript ou JQ. Este painel inclui um verificador de sintaxe integrado que identifica e destaca erros na sintaxe da sua expressão.
Gerador de expressão do Autopilot	Localizado na parte inferior do painel de entrada, o gerador de expressões do Autopilot ajuda você a criar expressões de fluxo de trabalho usando linguagem natural, em vez de escrever JavaScript. O Autopilot entende o contexto do seu fluxo de trabalho e permite que você faça referência a objetos e etapas do fluxo de trabalho simplesmente descrevendo o resultado desejado.
Entrada de teste de atividade	Ao lado direito do painel de código, o painel de entrada de teste de atividade permite que você revise os dados de teste gerados em execuções de fluxo de trabalho anteriores. Ele fornece dados amostrais que você pode usar para construir e validar expressões e interage diretamente com o painel Saída de expressão para garantir que suas expressões produzam os resultados desejados.
Saída de expressão	O painel Saída de expressão exibe o resultado da sua expressão com base nos dados dos dados de entrada de teste de atividade . Isso permite que você valide se sua expressão gera o resultado esperado. Se sua expressão tiver erros, a seção Saída de expressão destacará a expressão problemática e fornecerá uma mensagem de erro correspondente. O resultado é atualizado automaticamente sempre que você modificar a expressão no painel de entrada.

Acesso a dados usando JavaScript

Há dois pontos de acesso para dados de fluxo de trabalho:

• $workflow— Refere-se à configuração no nível do fluxo de trabalho.
• $contextRefere-se à configuração no nível de atividade.
• $input—Refere-se à configuração da atividade executada anteriormente.

Importante: use a tela Entrada de teste dentro do Editor de expressão para fazer referência às propriedades da etapa ao construir suas expressões.

Pontos de acesso	Description	Como usar
$workflow.input	Armazena o esquema de solicitação e quaisquer valores definidos na configuração de teste.	Para acessar dados de configuração de teste dentro do Editor de expressão, insira a seguinte sintaxe e substitua {property_name} pela propriedade específica que você deseja fazer referência: $workflow.input.{property_name}
$context	Armazena os dados de entrada e saída para cada etapa do fluxo de trabalho. Para fazer referência a essas propriedades em suas expressões, primeiro execute e teste o fluxo de trabalho. Isso gera entradas e saídas no nível da etapa visíveis na tela Entrada de teste .	Para acessar os dados de resposta de saída de uma etapa específica, use o seguinte padrão de sintaxe no Editor de expressão e substitua {step_name} e {property_name} por seus nomes de etapa e propriedade, respectivamente: $context.outputs.{step_name}.content.{property_name}
$input	Armazena dados passados diretamente da etapa anterior para a etapa atual. Use $input para fazer referência às propriedades da etapa anterior sem navegar por todo o $context.	Para acessar as propriedades da etapa anterior, use a sintaxe a seguir e substitua {property_name}pela propriedade que você deseja referenciar: $input.{property_name}

Fluxos de trabalho da API de teste

Para uma integração bem-sucedida do fluxo de trabalho da API, teste seu fluxo de trabalho com antecedência e com frequência. Testes regulares ajudam você a identificar e resolver erros rapidamente. Funcionalidades como IntelliSense, conclusão automática, Autopilot e a tela de entrada de teste de atividade dependem dos dados do teste. Execute o fluxo de trabalho regularmente usando o botão Teste para gerar esses dados.

Os testes garantem:

• Seus mapeamentos de dados entre etapas do fluxo de trabalho estão corretos, impedindo comportamentos inesperados.
• As solicitações de API são configuradas corretamente, garantindo respostas confiáveis.
• Seu fluxo de trabalho funciona conforme esperado, reduzindo o risco de erros inesperados na produção.

Compreensão das informações de Saída de execução

O painel Saída de execução fornece informações detalhadas sobre a execução do fluxo de trabalho.

Dados de entrada e saída da atividade

Esses dados estão disponíveis por atividade selecionada e fornecem:

• Dados de entrada —informações que uma etapa recebe da atividade anterior.
• Dados de saída—Informações produzidas pela etapa atual, passadas para a próxima atividade.

Revise os dados de entrada/saída para confirmar mapeamentos precisos e transformações de dados.

Informações de solicitação de API

Quando os fluxos de trabalho interagem com APIs, verifique os seguintes detalhes da solicitação:

• URL da Solicitação —Confirme se os parâmetros de URL dinâmicos são resolvidos corretamente.
• Cabeçalhos —Certifique-se de que os cabeçalhos de autenticação e tipo de conteúdo estejam definidos adequadamente.
• Parâmetros de consulta —verifique se os filtros e os parâmetros estão formatados corretamente.
• Conteúdo do corpo— Validar que a estrutura do JSON corresponde aos requisitos da API.

Solicitações de API bem-sucedidas

Para solicitações de API bem-sucedidas, expanda cada etapa para revisar:

• Detalhes da solicitação— URL, cabeçalhos, parâmetros de consulta e conteúdo do corpo.
• Detalhes da resposta— Código de status, cabeçalhos e conteúdo da resposta.
• Dados de saída—Informações geradas pela chamada de API para uso em etapas subsequentes do fluxo de trabalho.

Depuração

Para identificar e depurar com eficiência erros de fluxo de trabalho, siga estas diretrizes:

• Indicadores de erro
  • As etapas que encontram erros exibem um ícone de erro.
  • Selecione a etapa para visualizar mensagens de erro e saídas detalhadas.
• Etapas de depuração comuns
  • Validar solicitações de API— Certifique-se de que detalhes da solicitação, como URLs, cabeçalhos, parâmetros e conteúdo do corpo correspondam à documentação da API.
  • Revise mensagens de erro—Examine as mensagens de erro em busca de dicas sobre erros de autenticação, cargas incorretas ou erros de script.

Adicionando uma configuração de Debug

É possível criar e testar seu fluxo de trabalho da API iterativamente, validando cada etapa à medida que você adiciona novas atividades. Para executar esses testes de forma eficaz, você pode definir dados de entrada específicos usando a funcionalidade de configuração Depuração . Isso permite que você defina uma entrada JSON uma vez e a reutilize em todas as execuções de testes subsequentes. Você pode acessar os dados emulados por meio do objeto $workflow.input durante a execução do fluxo de trabalho.

Para adicionar uma configuração de Depuração:

1. Na parte superior da tela de designer do fluxo de trabalho de API, abra o menu suspenso Depurar e selecione Configuração de depuração.
2. Na janela que se abre, forneça os dados de entrada de teste no formato JSON.
3. Salve sua configuração de teste.
4. Depois de salvar, você pode acessar a configuração de teste no Editor de expressão usando a referência $workflow.input.{propertyname}. Além disso, a configuração de depuração também é exibida no painel de entrada Teste de atividade do editor de Expressão.

Depurando seu fluxo de trabalho da API

Para depurar seu fluxo de trabalho da API:

1. Abra seu fluxo de trabalho da API. Certifique-se de que seu fluxo de trabalho esteja totalmente configurado e pronto para ser executado.
2. Se seu fluxo de trabalho depender de dados de entrada, por exemplo, de um sistema externo, defina a configuração de Depuração antes de testar. Isso garante que cada etapa receba os dados necessários.
3. Depure seu fluxo de trabalho. O botão Depurar fica na parte superior da página. Selecione-a para executar o fluxo de trabalho e ver os resultados em tempo real.
4. Depois que a depuração for iniciada, o painel Saída de execução aparecerá no lado direito da tela. Aqui, você pode ver o status de execução de cada etapa claramente marcado como bem-sucedido, falha ou pendente.

Publicação de fluxos de trabalho da API

Importante: antes de publicar, teste seu fluxo de trabalho de API usando cenários de sucesso e falha para confirmar que cada cenário é executado corretamente.

Para publicar sua solução de fluxo de trabalho de API:

1. Na sua tela de designer de fluxo de trabalho de API, selecione Publicar.
2. Selecione o local onde seu fluxo de trabalho da API deve ser publicado:
   • Feed de seu espaço de trabalho pessoal do Orchestrator
   • Seu feed de tenant do Orchestrator
3. Forneça outros detalhes importantes para o fluxo de trabalho da sua API, como Log de alterações e Versão.
4. Selecione Publicar. Uma notificação informa a você sobre a publicação bem-sucedida de seu fluxo de trabalho da API.

Se você publicou em seu feed do espaço de trabalho pessoal, o fluxo de trabalho é visível no Orchestrator em Meu Espaço de Trabalho > Automações > Processos. Os fluxos de trabalho de API são identificáveis pelo tipo API.

Se você publicou no seu feed de tenant, o fluxo de trabalho estará visível no Orchestrator em Tenant > Soluções. Os fluxos de trabalho de API são identificáveis pelo tipo API.

Implantação de fluxos de trabalho de API

Depois de publicar seu fluxo de trabalho da API no feed de sua preferência, você precisa implantar a solução.

Implantação de fluxos de trabalho de API a partir de seu feed de espaço de trabalho pessoal

A publicação em seu espaço de trabalho pessoal prepara o fluxo de trabalho da API como um processo em Orchestrator > Meu espaço de trabalho > subpasta do nome do fluxo de trabalho de sua API > Automações > Processos.

Importante: uma subpasta dedicada é criada automaticamente dentro da sua pasta de espaço de trabalho pessoal.

Implantar fluxos de trabalho de API a partir de seu feed de tenant

Publicar em seu tenant do Orchestrator carrega o pacote de fluxo de trabalho da API para Orchestrator > Tenant > Soluções.

Para implantá-lo como um processo:

1. Acesse Orchestrator > Tenant > Soluções.
2. Para o pacote de fluxo de trabalho de API que você publicou anteriormente em seu feed de tenant, selecione o menu de três pontos e, em seguida, selecione Implantar pacote.
3. No assistente Implantar versão da solução , configure os seguintes detalhes:
   1. Nome da implantação— adicione o nome a ser exibido em todas as páginas que mencionam, listam ou monitoram processos. Se deixado em branco, o nome do pacote será usado.
   2. Pasta de destino— indique a pasta a ser usada como uma pasta pai para a raiz da solução. A solução não é implantada na pasta selecionada, mas uma nova pasta filha é criada.
   3. Instalar como uma nova pasta raiz no tenant— marque essa caixa de seleção para instalar a solução como uma nova pasta raiz no tenant atual.
   4. Nome da pasta raiz da solução— altere o nome da pasta raiz.
4. Selecione Revisar. Agora, você pode salvar sua solução como um rascunho, ou validá-la e continuar.
5. Selecione Implantar. Agora você pode encontrar seu fluxo de trabalho como um processo na pasta indicada na etapa 3 > Automações > Processos. Você pode identificar um fluxo de trabalho de API pelo tipo API.
6. Selecione Ativar implantação para finalizar a implantação do seu fluxo de trabalho da API.

Melhores práticas

• Defina esquemas de entrada e saída claros para que outros produtos da UiPath possam entender e interagir com seu fluxo de trabalho.
• Aproveite a rápida velocidade de execução dos fluxos de trabalho da API para testar cargas de entrada e saída durante o período de design.
• Use o Autopilot para gerar expressões com reconhecimento de contexto e código JavaScript.
• Valide as expressões no painel de saída do Editor de Expressão para detectar problemas de sintaxe ou lógica antes do runtime.
• Interaja com dados de entrada e saída no painel Saída da execução expandindo, recolhendo ou copiando valores para a área de transferência.
• Saia do fluxo de trabalho no início configurando uma atividade de Resposta, como Sucesso ou Falha.
• Em atividades Loop , ou seja, For Each e Do While, use $input em vez de $context para acessar a saída do objeto anterior.
• Use a atividade HTTP para chamar APIs diretamente quando um conector não fornecer a funcionalidade necessária. Escolha entre a atividade HTTP nativa ou a atividade HTTP Request específica do conector.
• Forneça tokens de autenticação na propriedade Cabeçalhos da atividade HTTP :

  { 
      Authorization: "<my_token>",
      "Content-Type": "application/json"
  }

  Para a autenticação básica, use:

  { Authorization: "Basic " + btoa("<username>:<pass>")}