Mudanças entre as edições de "TPHConexaoREST"

(Propriedades)
Linha 38: Linha 38:
 
|}
 
|}
  
== Exemplo ==
+
===Procedimentos===
 +
* '''AddParametro(Nome: String; Valor: String)''': Adiciona parâmetros na requisição;
 +
* '''AddHeader(Nome: String; Valor: String)''': Adiciona cabeçalhos na requisição;
 +
* '''Clear''': Limpa a configuração da requisição;
 +
* '''Executar''': Executa a requisição.
 +
 
 +
===Exemplo===
  
 
   Rest := NewPHConexaoREST;
 
   Rest := NewPHConexaoREST;

Edição das 16h30min de 13 de janeiro de 2021

Conceito

O objeto TPHConexaoREST pode ser utilizado para realizar requisições em webservices.

Propriedades

Nome Tipo Descrição
URL String Endereço URL da API.
Metodo String Tipo do método da requisição. Valores aceitos: 'GET', 'POST', 'DELETE' e 'PUT'.
Body String Conteúdo da requisição normalmente é utilizado uma estrutura em JSON.
Bearer Token String Token de acesso em caso de requisições que exigem esse tipo de autenticação.
ContentType String Tipo de conteúdo do body, exemplo: 'APPLICATION/JSON' ou 'TEXT/XML'.
Retorno String Propriedade que contém o retorno da requisição após a execução.
RetornoErro Boolean Se houver algum erro durante a execução a propriedade assume o valor 'True'.

Procedimentos

  • AddParametro(Nome: String; Valor: String): Adiciona parâmetros na requisição;
  • AddHeader(Nome: String; Valor: String): Adiciona cabeçalhos na requisição;
  • Clear: Limpa a configuração da requisição;
  • Executar: Executa a requisição.

Exemplo

 Rest := NewPHConexaoREST;
 try
   Rest.Metodo := 'POST'; // Informar o método em string                                                       
   Rest.URL := 'http://url-da-api.com.br/processo';
  
   // É possível declarar diversos pârametros no Header
   Rest.AddHeader('Content-Type', 'application/json');     
   // Informar conteúdo do body quando houver               
   Rest.Body := 'Conteúdo diverso';
   Rest.Executar;      
   if not Rest.RetornoErro then
     informacao(Rest.Retorno);          
 finally
   REST.Free;                      
 end;