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

(Propriedades)
(Propriedades)
Linha 25: Linha 25:
 
|Token de acesso em caso de requisições que exigem esse tipo de autenticação.
 
|Token de acesso em caso de requisições que exigem esse tipo de autenticação.
 
|-
 
|-
|AssuntoStr
+
|ContentType
 
|String
 
|String
|Descrição do assunto do e-mail.
+
|Tipo de conteúdo do body, exemplo: 'APPLICATION/JSON' ou 'TEXT/XML'.
 
|-
 
|-
|UsarThread
+
|Retorno
|Boolean
+
|String
|Determina se o sistema vai aguardar o envio do e-mail ou se será iniciar thread para execução em segundo plano.
+
|Propriedade que contém o retorno da requisição após a execução.
|-
 
|ExibirTelaEnvio
 
|Boolean
 
|Quando enviar, será exibida tela de envio de e-mail.
 
|-
 
|Confirmado
 
|Boolean
 
|Quando a propriedade 'ExibirTelaEnvio' estiver marcada, esta propriedade vai retornar verdadeira se o usuário confirmar o envio.
 
 
|-
 
|-
|MostrarProcesso
+
|RetornoErro
 
|Boolean
 
|Boolean
|Caso estiver sendo utilizado objeto de exibição de processo, será exibido o procedimento que o e-mail esta executando.
+
|Se houver algum erro durante a execução a propriedade assume o valor 'True'.
 
|}
 
|}
  

Edição das 16h26min 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'.

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;