Pular para o conteúdo principal

Chamada REST

Configuração atual da tarefa Chamada REST no Workflow Designer

A Tarefa Chamada REST permite que o Fluxo de Trabalho interaja com sistemas externos através de API REST. Permite enviar requisições HTTP e gerenciar as respostas de serviços web, habilitando a integração com aplicações externas.

É a ferramenta principal para comunicar com outras plataformas, como ServiceNow, Salesforce, sistemas de ticketing, bases de dados cloud e inúmeros outros serviços, seja para recuperar dados (GET) ou para enviar ou modificar informações (POST, PUT).

Configuração​

A configuração da Tarefa define cada aspecto da requisição HTTP que será enviada. Os campos de configuração da Tarefa podem ser preenchidos manualmente ou através de parâmetros e variáveis do fluxo de trabalho.

Conexão SSL​

Especifica se a chamada deve utilizar o protocolo SSL (sim / não).

Proxy

Define o encaminhamento da conexão através das seguintes opções:

  • Configuração do sistema: utiliza o proxy configurado a nível global.
  • Sem Proxy: a chamada é efetuada diretamente sem passar por um proxy.
  • Proxy personalizado: habilita o campo Endereço do Proxy para inserção manual de um servidor dedicado.

URL​

Neste campo deve ser inserido o endereço completo do endpoint para onde a requisição será enviada. É possível construir a URL de forma dinâmica utilizando parâmetros.

Autenticação​

Um menu para selecionar o método de autenticação exigido pela API de destino. As opções são:

  • Nenhuma: Para APIs públicas que não requerem credenciais.
  • Basic: Autenticação padrão através de nome de utilizador e palavra-passe.
  • Bearer: Autenticação através de um token de segurança (Bearer Token) que deve ser inserido no header da requisição.

Utilizador​

O nome de utilizador para autenticação do tipo Basic.

Palavra-passe​

A palavra-passe associada ao utilizador para autenticação Basic.

Token​

O campo onde inserir o token de segurança quando se utiliza autenticação do tipo Bearer.

Método​

O método HTTP a utilizar para a requisição, que define o tipo de operação a ser executada

  • GET: Para recuperar dados de um recurso.
  • POST: Para criar um novo recurso.
  • PUT: Para atualizar completamente um recurso existente.
  • Área de texto dedicada à definição dos headers HTTP a incluir na requisição. Os headers devem ser especificados como array de strings, onde cada elemento representa um header no formato:
  • Formato requerido: ["Chave: Valor", "Chave2: Valor2"]
  • Exemplo base: ["Content-Type:application/json;charset=utf-8"] - chave*: Content-Type e* valor*: application/json;charset=utf-8*
  • Exemplo Conteúdo e Idioma: ["Content-Type:application/json;charset=utf-8", "Accept: application/json", "Accept-Language: it-IT, it;q=0.9"]

Body​

Uma área de texto para inserir o corpo (payload) da requisição. Este campo é utilizado principalmente com métodos como POST e PUT para enviar os dados a serem criados ou modificados. Para garantir que o conteúdo JSON seja interpretado corretamente, é necessário utilizar a diretiva “string:”.

Exemplo:

string:{
 "state": "#>state<#",
 "work_notes": "#>work notes<#"
}

Exemplo de uso​

Parâmetros de Saída​

Assim que o serviço externo responder à chamada, a Tarefa expõe os seguintes parâmetros de saída, que são cruciais para processar o resultado da requisição:

  • headers: Contém os cabeçalhos da resposta enviados pelo servidor.
  • response: Contém o corpo da resposta enviada pelo servidor.
  • result: Indica o estado geral da execução da Tarefa.
  • resultJson: representa o resultado da execução da tarefa em formato JSON, incluindo informações gerais, configurações e detalhes da execução.
  • httpCode: Retorna o código de estado HTTP da resposta.
  • 200 (OK), 201 (Created): A solicitação foi bem-sucedida.
  • 400 (Bad Request), 401 (Unauthorized), 404 (Not Found): Erro do lado do cliente.
  • 500 (Internal Server Error): Erro do lado do servidor.

Exemplo de parâmetro resultJson​

{
  "run_info": {
    "status": "Completed",
    "run_result": "Success"
  },
  "output_parameters": {
    "exitStatus": "0"
  }
}