Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.

{{ajuda:logo-gsan3.png?90|}}


====== WebService Segunda Via Pix ======

<columns>
O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via **Query Parameter**.

Ele espera os seguintes Parâmetros:
  - key, //String// contendo a chave de autenticação da empresa.
  - matricula, //String// contendo o identificador do imóvel.
  - idConta, //Array de String// contendo o(s) identificador(es) da(s) conta(s)
</columns>
\\

===== Exemplo de requisição para o sistema =====

Com as seguintes informações:
|IP|192.168.64.111|
|Chave de autenticação|D8G5FGJOIKM3Q4598|
|matricula|70216630|
|idConta|["108932298", "109927116"]|


\\

===== A Requisição Seria =====
<code javascript>
http://192.168.64.111:8080/gsan/segundaViaPix?key=D8G5FGJOIKM3Q4598&matricula=70216630&idConta=["108932298", "109927116"]
</code>

\\

===== Retorno em Caso de Sucesso =====
<code javascript>
{
    "key": "D8G5FGJOIKM3Q4598",
    "body": {
        "mesAno": [
            "04/2023",
            "05/2023"
        ],
        "valor": [
            "4937.81",
            "3522.30"
        ],
        "codigoBarra": [
            "826900000496378100100189070216630015042023200035",
            "826800000356223000100188070216630015052023900039"
        ],
        "urlPix": [
            "00020126460014BR.GOV.BCB.PIX0114091236540001870206DEBITO52040000530398654074937.815802BR5906CAGEPA6007PARAIBA6229052501807021663001042023200036304ADD3",
            "00020126460014BR.GOV.BCB.PIX0114091236540001870206DEBITO52040000530398654073522.305802BR5906CAGEPA6007PARAIBA62290525018070216630010520239000363045984"
        ]
    }
}
</code>
\\

===== Possíveis Códigos de Retorno =====
|Código|Mensagem|
|400|"parâmetros inválidos"|
|401|"chave inválida"|
|404|"A consulta não trouxe resultados"|
|500|“”|
\\

Clique **[[=integracoes:web-services|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.