Mudanças entre as edições de "Listar boletos abertos - API"

(Alterei uma única palavra)
(Inserido código na biblioteca curl)
 
Linha 3: Linha 3:
 
'''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 boletos abertos de um determinado cliente.'''
 
'''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 boletos abertos de um determinado cliente.'''
  
'''2 -''' Após realizar a configuração da API no equipamento do cliente, basta criar o seguinte código:
+
'''2 -''' Após realizar a configuração da API no equipamento do cliente, basta criar o seguinte código, para listar os boletos com status À receber do financeiro do cliente:
 
[[Arquivo:Boletos Abertos API.png|centro|semmoldura|800x800px]]
 
[[Arquivo:Boletos Abertos API.png|centro|semmoldura|800x800px]]
 
'''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''':
 
'''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''':
 
[[Arquivo:Retorno de requisição API ( boletos abertos ) .png|centro|semmoldura|800x800px]]
 
[[Arquivo:Retorno de requisição API ( boletos abertos ) .png|centro|semmoldura|800x800px]]
 
'''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.'''
 
'''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.
 +
[[Arquivo:Captura de Tela 2019-08-14 às 14.38.00.png|centro|miniaturadaimagem|800x800px]]
 +
'''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.
 +
[[Arquivo:Captura de Tela 2019-08-14 às 14.00.34.png|centro|miniaturadaimagem|800x800px]]
  
 
-
 
-
  
 
Desenvolvido Juliano - Suporte - IXCSoft.
 
Desenvolvido Juliano - Suporte - IXCSoft.
 +
 +
-
 +
 +
Revisado por Rafael - Suporte IXCSoft
  
 
-
 
-
  
 
Voltar ao menu [[Recursos da API]].
 
Voltar ao menu [[Recursos da API]].

Edição atual tal como às 14h41min de 14 de agosto de 2019

No sistema IXC Provedor, podemos realizar várias tarefas diárias do sistema via API, dentre elas, consultar os boletos abertos de um cliente.

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 boletos abertos de um determinado cliente.

2 - Após realizar a configuração da API no equipamento do cliente, basta criar o seguinte código, para listar os boletos com status À receber do financeiro do cliente:

Boletos Abertos API.png

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:

Retorno de requisição API ( boletos abertos ) .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.

Captura de Tela 2019-08-14 às 14.38.00.png

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-08-14 às 14.00.34.png

-

Desenvolvido Juliano - Suporte - IXCSoft.

-

Revisado por Rafael - Suporte IXCSoft

-

Voltar ao menu Recursos da API.