Listar clientes por CPF - API

No sistema IXC Provedor, podemos realizar várias tarefas diárias do sistema via API, dentre elas, buscar cliente pelo CPF.

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 após esta configuração, realize os passos abaixo para listar os clientes por CPF.

2 - Após realizar a configuração da API no equipamento do cliente, basta criar o seguinte código, para listar o cliente referente a determinado CPF:

 1 <?php
 2 //requerindo arquivo do Webservice
 3 require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
 4 //URL do sistema
 5 $host = 'https://IP/webservice/v1';
 6 //Token do usuario criado nas configurações da API
 7 $token = 'TOKEN';
 8  //true para certificado auto assinado
 9 $selfSigned = true;
10 
11 //instanciando API requerida na primeira linha do código
12 $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
13 //Array de parâmetros do método
14 $params = array(
15     'qtype' => 'cnpj_cpf',//campo de filtro
16     'query' => '115.895.877-31',//valor para consultar
17     'oper' => '=',//operador da consulta
18     'page' => '1',//página a ser mostrada
19     'rp' => '20',//quantidade de registros por página
20     'sortname' => 'cliente.id',//campo para ordenar a consulta
21     'sortorder' => 'desc'//ordenação (asc= crescente | desc=decrescente)
22 );
23 
24 //Execução do metodo GET API
25 $api->get('cliente', $params);
26 
27 //false para json | true para array
28 $retorno = $api->getRespostaConteudo(false);
29 var_dump($retorno);

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

Captura de Tela 2019-09-05 às 09.21.15.png

2.2 - No exemplo acima, temos o retorno sendo feito em JSON, para que o mesmo seja retornado em formato de array PHP, precisamos apenas mudar o parâmetro que está dentro de $api->getRespostaConteudo(), ao invés de deixarmos como FALSE, alteramos para TRUE e a API já se encarrega de retornar os dados em array PHP.

3.0 - Mesma requisição porém feita com a biblioteca curl em php.

<?php
curl -s -k -H "Authorization:Basic NTA6YTE3ZjVjYWRkZGIyOTNlMDEwMTQ3OGEzZmFkOGVlYjQyZTRmYWIwNDAzZWE0ZDBmYTY5ZjNhNDJhMjg2YWViMw==" -H "Content-Type: application/json" -X POST -H "ixcsoft:listar" -d '{"qtype":"cnpj_cpf", "query" : "641.936.380-22", "oper" : "=","rp":"1","sortname" : "cliente.id", "sortorder" : "desc"}' https://10.65.1.171/webservice/v1/cliente
?>

3.1 - Foram utilizados os mesmo parâmetros para a pesquisa feita em curl, porém em curl temos que converter o token para base64, neste exemplo compilamos a requisição no terminal.

Captura de Tela 2019-09-05 às 09.30.20.png

-

Voltar ao menu Recursos da API.