Ao adicionar uma ação manualmente, você deve configurar os detalhes da ação adicionando o caminho e os parâmetros de consulta, cabeçalhos, solicitações e resposta.

Ao importar a definição de API, é necessário verificar e editar os detalhes da ação para garantir que ela tenha os valores apropriados com base nos seus requisitos. Esses detalhes serão exibidos no Bot editor ou no editor de API Task ao usar o pacote. Ao adicionar uma ação, a página de configuração Ações é exibida. A guia Configuração exibe várias configurações e a guia Teste permite que você teste a ação. As seguintes configurações estão disponíveis na guia Configuração.

Configurações na guia Configuração

Método HTTP
Especifique o tipo de solicitação REST que você deve enviar ao servidor REST API. Os seguintes métodos HTTP são compatíveis:
  • GET
  • PUT
  • POST
  • DELETE
  • PATCH
Nota: Ao importar uma definição de API, o editor de conectores ignora as ações com métodos não compatíveis e inclui o restante no conector personalizado.
Endpoint
Insira o URL do endpoint que você usa para essa ação. O usuário do pacote não pode ver esse URL. Use chaves {} para incluir o caminho e os parâmetros de consulta no URL. Por exemplo, /{version}/product/{productid}?status={productStatus}.
URL completo
Esse campo somente leitura exibe o campo gerado automaticamente que combina o URL base que você insere ao criar o pacote e o URL do endpoint do campo Endpoint. Esse URL não estará visível para o usuário do pacote.
Parâmetros da solicitação
Os parâmetros de solicitação permitem identificar, classificar e filtrar as respostas do servidor API. Use a opção Adicionar parâmetro para adicionar parâmetros de solicitação. Você pode adicionar parâmetros de caminho e de consulta. Certifique-se de que os parâmetros correspondam ao caminho de URL do Endpoint. Para mais informações sobre como adicionar parâmetros de solicitação, veja Parâmetros da solicitação.
Cabeçalhos da solicitação
Os cabeçalhos de solicitação permitem adicionar informações adicionais à solicitação. Você pode adicionar cabeçalhos de solicitação como Accept, Content-Length, Content-Type e Cookie. Para obter mais informações sobre como adicionar cabeçalhos de solicitação, consulte Cabeçalhos da solicitação.
Corpo da solicitação
O corpo da solicitação permite importar uma carga útil de amostra para definir a estrutura do corpo da solicitação. A carga útil é o dado real necessário para criar, atualizar ou excluir um recurso no servidor da API. Quando a ação é executada, a solicitação inclui essa carga útil. Para obter mais informações sobre como adicionar o corpo da solicitação, consulte Corpo da solicitação.
As seguintes opções estão disponíveis:
  • JSON: Selecione esta opção para importar uma amostra JSON para mapear os atributos do corpo da solicitação. Os nós folha serão capturados e exibidos aqui como uma lista de atributos. O JSON oferece flexibilidade com sua estrutura de pares chave-valor. Para obter mais informações sobre a opção JSON no corpo da solicitação, consulte JSON.
  • Dados do formulário: Selecione esta opção para adicionar parâmetros de dados do formulário como atributos do corpo da solicitação. A opção Dados do formulário é útil para carregar arquivos no servidor REST API, especificando o tipo de conteúdo. Para mais informações sobre a opção Dados de formulário, consulte Dados do formulário.
  • Dados codificados em URL de formulário: Selecione esta opção para adicionar parâmetros do corpo da solicitação no formulário HTML como pares de chave-valor codificados em URL, semelhantes aos parâmetros de solicitação do tipo consulta. Para obter mais informações sobre Dados codificados com URL de formulário, consulte Dados codificados em URL de formulário
Resposta
A opção Resposta permite importar uma carga de amostra da resposta e escolher os atributos que você deseja exibir no Bot editor e no editor de API Task. Para obter mais informações sobre como adicionar um parâmetro de resposta, consulte Resposta