Pular para o conteúdo principal

Chamada REST autenticada

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

A tarefa Chamada REST autenticada executa uma requisição HTTP para um serviço externo. Suporta requisições anónimas, autenticação Basic ou Bearer, cabeçalhos personalizados, corpo da requisição e proxy.

Configuração

CampoDescrição
Conexão SSLIndica se usar uma conexão protegida.
ProxyUsa a configuração do sistema, nenhum proxy ou um proxy personalizado.
Endereço do proxyÉ obrigatório apenas ao selecionar um proxy personalizado.
URLEndereço do serviço. Pode conter parâmetros dinâmicos do fluxo de trabalho.
AutenticaçãoNenhuma, Basic ou Bearer.
Usuário e SenhaCredenciais exigidas pela autenticação Basic.
TokenCredencial exigida pela autenticação Bearer.
MétodoGET, POST ou PUT.
CabeçalhosLista JSON dos cabeçalhos a serem enviados.
CorpoCorpo da requisição; não é previsto para o método GET.

Os cabeçalhos são representados como uma lista de strings:

[
"Content-Type: application/json",
"Accept-Language: it-IT"
]

No corpo, podem ser usados parâmetros Sybot. Neste exemplo, os valores vêm de tarefas anteriores:

string:{
"documento": "#>document_name<#",
"stato": "#>document_status<#"
}

Não insira credenciais diretamente nos cabeçalhos ou no corpo quando os campos de autenticação apropriados estiverem disponíveis. Evite também incluir senhas, tokens ou conteúdo confidencial nos nomes das tarefas e nas mensagens destinadas aos logs.

Resultados

A tarefa disponibiliza:

  • os cabeçalhos e o corpo da resposta;
  • o código de status HTTP;
  • o resultado da operação;
  • o resumo estruturado da execução.

Utilize o código HTTP e o conteúdo da resposta nas condições subsequentes. Um código 2xx indica normalmente uma requisição aceite, enquanto os códigos 4xx e 5xx exigem o tratamento de erro previsto pelo fluxo de trabalho.

Verificação

Execute inicialmente a chamada com dados sintéticos e verifique em Logs o método, o código de resposta e qualquer mensagem de diagnóstico. Dados sensíveis não devem ser copiados para variáveis destinadas a notificações ou arquivos públicos.