Mudanças entre as edições de "Listar Serviços Adicionais de um contrato - API"

(new)
(new)
 
Linha 33: Linha 33:
  
 
-
 
-
 +
 +
Voltar ao menu [[Recursos da API]].

Edição atual tal como às 12h10min de 31 de julho de 2020

No sistema IXC Provedor, podemos realizar várias tarefas diárias do sistema via API, dentre elas, listar os serviços adicionais relacionados à determinado contrato.

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 seguinte TUTORIAL DE CONFIGURAÇÃO DA API, após esta configuração, realize os passos abaixo, para criar a funcionalidade de Desbloqueio de Confiança.

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

 1 <?php
 2 require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
 3 $host = 'https://SEUIP/webservice/v1'; 
 4 $token = '2:704bf0b8d9ed2f033150c4e04ab43f254c40f87ef3520e105b7595cee0a43507';//token gerado no cadastro do usuario (verificar permissões)
 5 $selfSigned = true; //true para certificado auto assinado
 6 $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
 7 $params = array(
 8     'qtype' => 'cliente_contrato_servicos.id_contrato',//campo de filtro
 9     'query' => '1',//id do contrato
10     'oper' => '=',//operador da consulta
11     'page' => '1',//página a ser mostrada
12     'rp' => '20',//quantidade de registros por página
13     'sortname' => 'cliente_contrato_servicos.id',//campo para ordenar a consulta
14     'sortorder' => 'desc'//ordenação (asc= crescente | desc=decrescente)
15 );
16 $api->get('cliente_contrato_servicos', $params);
17 $retorno = $api->getRespostaConteudo(true);// false para json | true para array
18 echo "<pre>";
19 print_r($retorno);
20 ?>

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

2020-07-29 09-58.png

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

-

Desenvolvido por Emanoelli Ferraz - Suporte IXCSoft.

-

Voltar ao menu Recursos da API.