Mudanças entre as edições de "Como utilizar o Like - API"

(Refeito o cabeçalho para tirar os dados da base e token, adição de mais comentários.)
 
(Uma revisão intermediária por um outro usuário não está sendo mostrada)
Linha 1: Linha 1:
'''1 -''' Antes de qualquer coisa, precisa-se realizar a '''configuração da API no equipamento do provedor''', para saber como realizar esta configuração, basta acessar o link [[Configurando acesso ao Webservice API Apache]] ou [[Configurando acesso ao Webservice API Nginx]].
+
'''1 -''' Antes de qualquer coisa, precisa-se realizar a configuração da API no equipamento do provedor, para saber como realizar esta configuração, basta acessar o link [[Configurando acesso ao Webservice API Apache]] ou [[Configurando acesso ao Webservice API Nginx]].
  
 
'''2 -''' Após realizar a configuração da API no equipamento do cliente, basta criar o seguinte código, para listar os contratos com determinada descrição:<syntaxhighlight lang="php" line="1">
 
'''2 -''' Após realizar a configuração da API no equipamento do cliente, basta criar o seguinte código, para listar os contratos com determinada descrição:<syntaxhighlight lang="php" line="1">
Linha 39: Linha 39:
 
?>
 
?>
 
</syntaxhighlight>'''2.1''' - O retorno recebido pode ser tanto de sucesso como de erro no caso de alguma inconsistência nos dados passados.
 
</syntaxhighlight>'''2.1''' - O retorno recebido pode ser tanto de sucesso como de erro no caso de alguma inconsistência nos dados passados.
 
-
 
 
Desenvolvido por Rafael - Suporte IXCSoft.
 
 
-
 
 
Revisado por Suporte - Diego Minichiello - IXCSoft.
 
  
 
-
 
-
  
 
Voltar ao menu [[Recursos da API]].
 
Voltar ao menu [[Recursos da API]].

Edição atual tal como às 15h52min de 11 de maio de 2021

1 - Antes de qualquer coisa, precisa-se realizar a configuração da API no equipamento do provedor, para saber como realizar esta configuração, basta acessar o link Configurando acesso ao Webservice API Apache ou Configurando acesso ao Webservice API Nginx.

2 - Após realizar a configuração da API no equipamento do cliente, basta criar o seguinte código, para listar os contratos com determinada descrição:

 1 <?php
 2 
 3 //requerindo arquivo do webservice
 4 require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
 5 
 6 //url do sistema
 7 $host = 'http://IP/webservice/v1';
 8 
 9 //token gerado no cadastro do usuario (verificar permissões)
10 $token = 'TOKEN';
11 
12 //true para certificado auto assinado
13 $selfSigned = false;
14 
15 //instanciando api requerida na primeira linha do código
16 $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
17 
18 //array de parâmetros do método
19 $params = array(
20     'qtype' => 'cliente_contrato',//campo de filtro
21     'query' => '',//valor para consultar
22     'oper' => '!=',//operador da consulta
23     'page' => '1',//página a ser mostrada
24     'rp' => '20',//quantidade de registros por página
25     'sortname' => 'cliente_contrato.id',//campo para ordenar a consulta
26     'sortorder' => 'desc',//,//ordenação (asc= crescente | desc=decrescente)
27     'grid_param' => json_encode(array(array('TB' => 'cliente_contrato.contrato',
28    'OP'=>'L','P'=>'Plano 1.5 Mbps',)))// Filtro da grid - API operador Like passado com L,acessando o campo descrição que no form se chama contrato.
29 );
30 
31 //execução do método GET API
32 $api->get('cliente_contrato',$params);
33 $retorno = $api->getRespostaConteudo(false);// false para json | true para array
34 
35 var_dump($retorno);//Imprime o retorno
36 ?>

2.1 - O retorno recebido pode ser tanto de sucesso como de erro no caso de alguma inconsistência nos dados passados.

-

Voltar ao menu Recursos da API.