Como configurar uma tarefa de API em um formulário

Crie e configure um formulário para invocar o Tarefa de API e mapeie as variáveis do Tarefa de API para os campos obrigatórios no formulário.

Pré-requisitos

  • Você deve ter uma licença do Bot Creator.
  • Você precisa primeiro criar uma Tarefa de API para invocá-la no formulário.
Este tópico descreve como invocar uma Tarefa de API em um Formulário. Neste exemplo, você criará um formulário de CEPs que invoca uma Tarefa de API para recuperar os detalhes place e state com base na entrada de CEP fornecida. O formulário criado é executado por meio de um processo. Você pode criar um formulário com os campos específicos do seu caso de uso.

Procedimento

  1. Navegue até um formulário existente ou crie um formulário no qual deseja invocar um Tarefa de API. Para mais detalhes, consulte Criar um formulário.
    Nomeie este formulário como Tarefa da API — Formulário de CEP.
  2. Crie um formulário: Use os elementos do formulário para criar um formulário interativo com base em seu caso de uso. Neste exemplo, o formulário foi projetado para mapear as variáveis de CEP a partir da Tarefa de API.
    1. Na coluna Elementos, arraste o elemento Caixa de texto e solte-o no designer de formulários.
      A guia Propriedades é exibida com os campos relevantes no lado direito da tela.
    2. Digite um Rótulo do elemento. Por exemplo: CEP
    3. Arraste o elemento Botão e solte-o no designer abaixo da caixa de texto CEP. Digite um nome para este botão no campo Texto do botão (obrigatório), como Enviar.
    4. Além disso, arraste mais dois elementos de Caixa de texto e nomeie-os como Local e Estado.
  3. Adicione as Regras de formulário. As regras de formulário fornecem as condições necessárias para cada elemento do formulário. Você pode definir regras de formulário usandoifethene especificar as ações que serão executadas quando as condições forem atendidas. Neste exemplo, as regras do formulário são configuradas para que quando um CEP for inserido e o botão Enviar for pressionado, a caixa do elemento local e estado recuperará os valores das variáveis de Tarefa de API. Durante a execução, a Tarefa de API não terá o desempenho esperado se as condições da regra de formulário não forem atendidas.
    1. Clique na guia Regras de formulário.
    2. Se desejar, digite um nome para a regra. (Por exemplo, chamada de Tarefa de API).
    3. Insira uma condição If para validar se o botão é pressionado.Como invocar uma tarefa de API no formulário
    4. Para definir a cláusula Then, selecione Ações de formulário e, em seguida, no menu suspenso, selecione Obter valor da chamada de API.
    5. Você pode mapear variáveis associadas ao Tarefa de API em um formulário usando a opção Adicionar mapeamento de variáveis.
      Nota: Se você editar um Tarefa de API publicado e adicionar outras variáveis depois de ter feito o checkin da tarefa, as variáveis não serão exibidas no formulário. Faça o checkin do Tarefa de API depois de adicionar as variáveis.
    6. Clique em Procurar, para selecionar uma Tarefa de API específica para executar uma determinada operação. Neste exemplo, uma Tarefa de API (Tarefa de API — CEP) é selecionada para recuperar o Local e o Estado de qualquer CEP.