Obtém todos os cabeçalhos enviados pelo servidor em resposta a uma solicitação HTTP. Campos de cabeçalho HTTP são componentes da seção de cabeçalho das mensagens de requisição e resposta no Protocolo de Transferência de Hipertexto (HTTP). Eles definem os parâmetros de operação de uma transação HTTP. 

Open

Figura 1 -  Bloco Obter cabeçalho da URL

Para obter o conteúdo da resposta do servidor da requisição, utilize o bloco Obter conteúdo da URL.

Compatibilidade

• Bloco servidor: cronapi.util.Operations.getHeadersFromExternalURL()

Retorno

Retorna um objeto com os campos do cabeçalho HTTP da requisição.

Parâmetros

Método da requisição

Permite selecionar o verbo HTTP do recurso.

• Posição: 1

• Inglês: Request method

• Tipo: Texto / String

• Exemplo: Get

• Opções:

  • GET: solicita uma representação de dados de um recurso específico.

  • POST: submete dados a serem processados para um recurso específico.

  • PUT: usado para enviar dados ao servidor para criar ou atualizar um recurso específico. O corpo da requisição contém os dados a serem armazenados ou atualizados. Se o recurso não existir, ele pode ser criado; se já existir, ele será atualizado com os novos dados.

  • DELETE: apaga o recurso especificado.

Tipo de conteúdo

Oferece duas opções de formatos de dados amplamente utilizados na comunicação entre sistemas.

• Posição: 2

• Inglês: Content type

• Tipo: Texto / String

• Exemplo: JSON

• Opções:

  • x-www-form-urlencoded: Neste formato, os dados são codificados como pares chave-valor, onde os valores são codificados e separados por '&' e espaços são codificados como '+' ou '%20'. Exemplo: chave1=valor1&chave2=valor2&chave3=valor3

  • JSON: É um formato de dados que é amplamente utilizado para a troca de dados entre um cliente e um servidor. Ele é baseado em pares chave-valor e suporta estruturas de dados aninhadas.

Endereço URL

Endereço URI de onde os campos e cabeçalhos serão obtidos.

• Posição: 3

• Inglês: URL address

• Tipo: Texto / String

• Exemplo: "https://minhaapi.com/user/345678/info"

Parâmetros

Parâmetros a serem utilizados como filtros da requisição. É necessário passar um objeto JSON com objetos para cada parâmetro. Podemos utilizar o bloco Criar mapa com para passar os valores como chave/valor.

• Posição: 4

• Inglês: Parameters

• Tipo: Mapa / Map

• Exemplo: "{"id":"345678"}"

Cabeçalho de requisição

Objeto com atributos a serem tratados pelo serviço. É necessário passar um mapa (ou objeto JSON) com os atributos.

• Posição: 5

• Inglês: Headers

• Tipo: Mapa / Map

• Exemplo: "{"X-AUTH-TOKEN":"eyJhbGMiJ9.eyJzdWIsI..."}"

Exemplo 

A função abaixo utiliza o bloco Obter Cabeçalho da URL para fazer uma requisição a um endpoint e imprime o cabeçalho de resposta dessa requisição no Console do depurador. 

Open

Figura 2 - Exemplo de requisição utilizando o bloco Obter cabeçalho da URL

Nesta página