Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: DI-2131

Obter cabeçalho da URL

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. 


Image Added

Figura 1 -  Bloco Obter cabeçalho da URL


Dica

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

Parâmetros de Entrada

ParâmetroNomeTipoDoc1Método da requisiçãoStringMétodo de requisição2Tipo de conteúdoStringTipo do conteúdo3Endereço URLString

Endereço URL a ter campos do cabeçalho obtidos

4ParâmetroMapaParâmetros a serem utilizados como filtros da requisição. É necessário passar um objeto JSON com objetos para cada parâmetro.

Compatibilidade

  • Bloco servidor: cronapi.util.Operations.getHeadersFromExternalURL()
5Cabeçalho de requisiçãoMapaObjeto com atributos a serem tratados pelo serviço. É necessário passar um objeto JSON com os atributos.

Retorno

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

Compatibilidade

Image Removed Servidor

Exemplo 1

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.

 Image Removed

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

Sobre cabeçalhos

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.

Informações
titleMais sobre

Cabeçalhos

Sobre URL - Localizador Uniforme de Recursos

Um URL se refere ao endereço de rede no qual se encontra algum recurso a ser acessado, como por exemplo uma página de internet, um arquivo de computador. Este acesso pode ser feito via Internet, por uma rede corporativa (como uma intranet) e etc.

Informações
titleMais sobre

URL

Sobre URI - Identificador Uniforme de Recursos

Uniform Resource Identifier (em inglês) é a uma cadeia de caracteres compacta usada para identificar ou denominar um recurso na Internet. O principal propósito desta identificação é permitir a interação com representações do recurso através de uma rede usando protocolos específicos. 

Informações
titleMais sobre

URI

Sobre os métodos de 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
A obtenção de cabeçalhos do URL pode ser feito utilizando essencialmente 4 métodos diferentes
  • :
    • GET: solicita uma representação de dados de um recurso específico.
    • POST: submete dados a serem processados para um recurso específico.
    • PUT:
requisita que uma entidade seja armazenada embaixo do URI fornecido. Se o URI se refere a um recurso que já existe, ele é modificado; se o URI não aponta para um recurso existente, então o servidor pode criar o recurso com esse URI
    • 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.

Image Removed

Figura 2 - Métodos de Requisição 

Dica

Acesse Cabeçalhos HTTP para maiores informações.

Sobre os tipos de conteúdo

A codificação URL é frequentemente utilizada no envio de formulários web através de uma requisição POST. A codificação padrão empregada nesse envio é a "

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
". Este é um formato para codificação de 
    • : Neste formato, os dados são codificados como pares chave-valor
. Cada par chave-valor é separado por um caractere '&' e cada chave é separada de seu valor por um caractere '='. Chaves e valores são ambos escapados pela substituição de espaços com o caractere '+' e então utilização de codificação de URL em todos os caracteres não-alfanuméricos.
    • , 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.

 

Image Added

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

Nesta página

Índice

Bloco de código
languagexml
themeEclipse
firstline1
titleExemplo
linenumberstrue
collapsetrue
Os pares chave-valor:
 
Nome: Jonathan Doe
Idade: 23
Fórmula: a + b == 13%!
 
são codificados como:
 
Nome=Jonathan+Doe&Age=23&Formula=a+%2B+b+%3D%3D+13%25%21
Informações
titleMais sobre

x-www-form-urlencoded

JSON é um acrônimo para "JavaScript Object Notation". Um formato de padrão aberto que utiliza texto legível a humanos para transmitir objetos de dados consistindo de pares chave-valor. É o formato de dados mais comumente utilizado para comunicação assíncrona navegador/servidor.

Informações
titleMais sobre

JSON

Image Removed

Figura 3 - Tipos de conteúdo