API para consulta de débitos em aberto.
Introdução
No módulo do Balcão de Atendimento, foram desenvolvidas duas APIs destinadas ao retorno de débitos que estejam em aberto.
Procedimentos
A ferramenta utilizada para demonstrar os procedimentos a seguir e acessar as APIs externas é o Postman. Recomenda-se o uso dessa ferramenta, porém a escolha fica a critério do usuário.
1. Autenticação
Para iniciar a chamada da API desenvolvida, é necessário realizar a autenticação a fim de obter um token que será enviado para essa API. Utilizando a ferramenta escolhida, configure a requisição como POST e insira a URL de autenticação fornecida pela CEBI, que deve se assemelhar a: urlCebi/login/connect/token. É necessário preencher os parâmetros nos campos "Headers" e "Body". Em seguida, clique no botão "Send" para obter o token de autenticação. Para os parâmetros client_id e client_secret, é necessário fornecer o usuário e a senha disponibilizados pela própria CEBI.
2. Chamada de API
O tipo de requisição deve ser POST. A URL das APIs deve estar no seguinte formato:
- Contas: urlCebi/balcao_ssb/Api/Contas/ObtemContasAbertas/Externo
- Carnês: urlCebi/balcao_ssb/Api/Carnes/ObtemCarnesAbertos/Externo
No fornecimento das keys para a API, será possível informar os seguintes campos:
- Cdc: (inteiro)
- CpfCnpj: (texto)
O usuário poderá não preencher nenhum dos campos, porém é recomendado que seja realizado o preenchido, pois se não houver, o retorno dos dados irá demorar e a quantidade de registros poderá ser em larga escala.
Após a execução da chamada, o retorno será em formato JSON com todos os débitos.
3. Retorno das APIs
3.1. Contas
URL: (POST) urlCebi/balcao_ssb/Api/Contas/ObtemContasAbertas/Externo
| Campo | Tipo |
|---|---|
| Identificacao | Texto |
| Cdc | Texto |
| Grupo | Inteiro |
| Nome | Texto |
| Complemento | Texto |
| Numero | Texto |
| Hidrometro | Texto |
| Endereco | Texto |
| Vencimento | Data |
| ValorAgua | Decimal |
| ValorEsgoto | Decimal |
| Referencia | Texto |
| ValorTaxas | Decimal |
| ValorServicos | Decimal |
| Multa | Decimal |
| Juros | Decimal |
| Correcao | Decimal |
| SituacaoConta | Texto |
| DataCorte | Data |
| Economias | Inteiro |
| ConsumoReal | Inteiro |
| TotalCDC | Decimal |
| Usuario | Texto |
| CpfCnpj | Texto |
| Telefone | Texto |
| Texto |
3.2. Carnês
URL: (POST) urlCebi/balcao_ssb/Api/Carnes/ObtemCarnesAbertos/Externo
| Campo | Tipo |
|---|---|
| ExercicioCarne | Inteiro |
| NumeroCarne | Inteiro |
| Cdc | Texto |
| Identificacao | Texto |
| Nome | Texto |
| Endereco | Texto |
| NumeroParcela | Inteiro |
| Data | |
| Valor | Decimal |
| Multa | Decimal |
| Juros | Decimal |
| Correcao | Decimal |
| ValorTotal | Decimal |
| TelefoneConsumidor | Texto |
| Compromissario | Texto |
| Representante | Texto |
| DataCarneReferencia | Data |
| CpfCnpj | Texto |