IMPORTANTE: esta documentação foi descontinuada. Leia a documentação REST V1 atualizada no nosso novo portal de documentação.
O REST V1 realiza chamadas a endpoints REST a partir de um pipeline.
Dê uma olhada nos parâmetros de configuração do componente:
URL: URL a ser chamada - pode conter os parâmetros seguindo o padrão {:param1}, que serão substituídos pela propriedade correspondente da mensagem de entrada.
Content Type: configura o Content Type e a codificação.
Verb: tipo de chamada do REST (GET, POST e PUT).
Account: conta a ser utilizada pelo componente.
Connection Timeout: tempo de expiração da conexão (em milissegundos).
Reading Timeout: tempo máximo para leitura (em milissegundos).
Stop On Client Error: se ativada, a opção vai gerar um erro para suspender a execução do pipeline.
Stop On Server Error: se ativada, a opção vai gerar um erro para suspender a execução do pipeline.
Advanced Settings: configurações avançadas
Inject JWT: se ativada, a opção injeta o JWT presente na chamada do pipeline (gerado ou não pelo componente JWT) no header Authorization da chamada REST.
Read JWT: se ativada, a opção coloca como resposta o JWT que fica no header Authorization interno, caso exista.
Raw Mode: se ativada, a opção recebe ou passa um payload sem ser JSON.
Allow Insecure Calls To HTTPS Endpoints: quando ativada, a opção permite que chamadas não seguras a endpoints HTTPS sejam feitas.
Enable Retries: quanto ativada, a opção permite que sejam feitas novas tentativas.
Maximum Number Of Retries Before Giving Up: número máximo de tentativas antes de desistir da chamada.
Time To Wait Before Each Retry: tempo máximo entre tentativas (em milissegundos).
Compress Body With GZIP: quanto ativada, a opção permite que o body seja comprimido com GZIP.
Path Parameter
Exemplo
Query Parameter
Exemplo
Fluxo de Mensagens
Entrada
application/x-www-form-urlencoded
{
header: {
"headerA":"valueA",
"headerB":"valueB"
},
url: {
"urlParam1": "paramValue"
},
formData: {
"field1": "value1",
"field2": "value2"
}
}
multipart/form-data
{
header: {
"headerA":"valueA",
"headerB":"valueB"
},
url: {
},
multiPartData: {
"files": {
"file_formName" "filename",
"files_formName[]" ["filename1","filename2"]
}, "fields": {
"field1" : "value1",
"field2" : "value2",
}
}
}
O componente espera uma mensagem no seguinte formato:
{
header: {
"headerA":"valueA",
"headerB":"valueB"
},
url: {
"urlParam1": "paramValue"
},
body: {
// message to be sent to the endpoint
}
}
Saída
com sucesso
{
status: XXX,
body: {
},
headers: {
}
}
com erro
{
error: "error message",
code: XXX,
body: {
},
headers: {
}
}
IMPORTANTE: no caso de alguns erros, body e headers estarão indisponíveis.