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

 
(8 revisões intermediárias por 3 usuários não estão sendo mostradas)
Linha 1: Linha 1:
 
== Conceito ==
 
 
O objeto TPHConexaoREST pode ser utilizado para realizar requisições em webservices.   
 
O objeto TPHConexaoREST pode ser utilizado para realizar requisições em webservices.   
  
 
===Propriedades===
 
===Propriedades===
 +
{| class="wikitable" style="width: 100%"
 +
! 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', 'TEXT/XML' ou 'APPLICATION/OCTET-STREAM'.
 +
|-
 +
|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 ==
+
===Exemplo===
  
 
   Rest := NewPHConexaoREST;
 
   Rest := NewPHConexaoREST;

Edição atual tal como às 17h26min de 29 de outubro de 2021

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', 'TEXT/XML' ou 'APPLICATION/OCTET-STREAM'.
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;