Inserir novo produto a um contrato - API

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, nesta requisição vamos inserir um novo produto em um contrato.

 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 inserir o produto/plano no contrato do cliente
19 $dados = array(
20     'tipo' => 'I', //obrigatorio, tipo de plano: I = Internet, T = Telefonia, S = Serviços, SVA = SVA, TV = TV
21     'id_contrato' => '', //obrigatorio, ID do contrato  que será vinculado
22     'id_plano' => '', //obrigatorio para tipo Internet e Telefonia, ID do plano de velocidade
23     'id_produto' => '', //obrigatorio para tipo Serviços, SVA  e TV, ID do produto
24     'descricao' => '',// Campo de texto máx. 250 caracteres
25     'qtde' => '', //obrigatorio, Campo de texto máx. 15 caracteres
26     'valor_unit' => '', //obrigatorio, Campo de texto máx. 15 caracteres, Máscara: R$ - 9.999,99
27     'obs' => '',//Campo de texto máx. 500 caracteres
28     'valor_ate_vencimento' => ''//Campo de texto máx. 15 caracteres, Máscara: R$ - 9.999,99
29 );
30 
31 $api->post('vd_contratos_produtos', $dados); //Faz a o POST na API na tabela vd_contratos_produtos
32 $retorno = $api->getRespostaConteudo(false);// false para json | true para array
33 
34 var_dump($retorno_produto); //Imprime os produtos cadastrados
35 ?>

2.1 - O retorno recebido vai ser de sucesso, que será semelhante a esse exemplo:

Captura de Tela 2019-11-05 às 11.52.23.png
Atenção:

É obrigatório preencher id_plano em caso seja um tipo Internet ou Telefonia ou caso seja Serviços, SVA ou TV é obrigatório que seja preenchido o id_produto.

Deve-se salientar a importância de qualquer alteração na tabela vd_contratos_produtos.

A responsabilidade ao utilizar a mesma é TOTALMENTE DO DESENVOLVEDOR que esta utilizando a API, o mesmo deve estudar a documentação e entender os conceitos e vínculos do IXC, pois caso fizer qualquer alteração errada com essa rota, poderá vir afetar diretamente os planos e consequentemente gerar transtornos em vários lugares do sistema como por exemplo: financeiro, autenticação, bloqueio ou desconexão de clientes entre outros.

-

Voltar ao menu Recursos da API