Pular para o conteúdo principal

Consultar Analises

Requisição​

GET [Url Ambiente]/Energia/Consultar

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json
Token [Obtido na Autenticação]"123123123"

Query​

ParâmetroDescriçãoTipoExemplos
ChaveCampo para identificação da requisiçãoString"ChaveDefinidaPeloCliente"

Exemplo​

curl -X GET "https://api-energia.plataformaacertpix.com.br/Energia/Consultar?Chave=5100053" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "Token: 12312334131"

Status Code 200​

Retorno de sucesso.

Com acesso ao token e chave, será possível obter o retorno/consulta da análise. Segue campos que são retornados na consulta:

ParâmetroDescriçãoTipoExemplos
StatusCodeCódigo de status da respostaInt200
MessageDescrição de sucesso ou falha da requisiçãoObjeto{"TypeMessage": "200", "Message": "Processing succeeded"}
Analise.StatusStatus da análise. Consultar: StatusInt1
Analise.IdAnaliseID da AnáliseInt37130
Analise.ChaveChave da análiseString"ChaveDefinidaPeloCliente"
Analise.DataCadastroData de cadastro da análiseString"2024-07-23T16:51:59"
Analise.DataFinalizadoData de finalização da análiseString"2024-07-23T16:52:10"
Analise.QuantidadeQuantidade de imagens processadas nessa análiseInt0
Analise.Result.Distribuidora.MasterTypeTipo principal da distribuidora. Consultar: MasterTypesString"ENEL"
Analise.Result.Distribuidora.SubTypeSubtipo da distribuidora. Consultar: SubTypesString"enel ce"
Analise.Result.Qualidade.Dados_ClienteNível de qualidade dos dados do cliente. Consultar QualidadeInt1
Analise.Result.Qualidade.Contas_VencidasNível de qualidade das contas vencidas. Consultar QualidadeInt1
Analise.Result.Qualidade.Descricao_Do_FaturamentoNível de qualidade da descrição do faturamento. Consultar QualidadeInt1
Analise.Result.Qualidade.Historico_De_ConsumoNível de qualidade do histórico de consumo. Consultar QualidadeInt1
Analise.Result.Caracteristicas.PdfDocumento enviado é um PDFbooltrue
Analise.Result.Caracteristicas.GrayscaleDocumento enviado está na coloração cinzabooltrue
Analise.Result.Caracteristicas.DigitalDocumento enviado é um documento digitalbooltrue
Analise.Result.AlertasAlertas Anti-FraudeArray(A DEFINIR, SÃO APENAS EXEMPLOS) [{"Id": 10, "Descricao": "Mês de referencia está igual ao mês de vencimento"}, ...]
Analise.Result.Nome_CompletoNome completoString"FULANO DE TAL"
Analise.Result.CPF_CNPJCPF ou CNPJString"12345678911"
Analise.Result.Endereco_CompletoEndereço completoString"RUA X, 136 - CENTRO, SÃO PAULO - SP"
Analise.Result.CEPCEPString"11790-000"
Analise.Result.CidadeCidadeString"SÃO PAULO"
Analise.Result.UFUnidade federativaString"SP"
Analise.Result.Numero_InstalacaoNúmero da instalação. Consultar: CodigosDistribuidorasString "14151537"
Analise.Result.Numero_ClienteNúmero do cliente. Consultar: CódigosDistribuidorasString"14151537"
Analise.Result.Total_A_PagarTotal a pagarString"153.31"
Analise.Result.Mes_ReferenciaMês de referênciaString"05/2024"
Analise.Result.VencimentoData de vencimentoString"23/06/2024"
Analise.Result.Classificacao_Unidade_ConsumidoraClassificação da unidade consumidora. Consultar: ClassificaçõesString"B1"
Analise.Result.Contas_VencidasContas vencidasArray[{"vencimento": "04/2024", "valor": "253.48"}]
Analise.Result.Descricao_Do_FaturamentoDescrição do faturamentoArray[{"item_fatura": "0601 CONSUMO TE", "mes_ref": null, "quantidade_kwh": "30.00", "valor": "3.89"}, ...]
Analise.Result.Leitura_AtualLeitura atualString"03/04/2024"
Analise.Result.Proxima_LeituraPróxima leituraStringnull
Analise.Result.Tarifa_SocialIndica se é do tipo Tarifa SocialBooleantrue
Analise.Result.Historico_De_ConsumoHistórico de consumoArray[{"mes_ano": "MAI/24", "consumo_faturado": "237.0"}, ...]
Analise.Result.Codigo_BarrasCódigo de barrasString"34191094203571983293985387840009197430000020975"
Analise.Result.QrCodeLink dos QrCodes extraídos do documentoArray["https://link", "https://link2"]
Analise.Result.ImageIndexÍndice no array de imagens recebidoInt0
Analise.Result.ErroEm casos de erro, retorna uma mensagem de identificação de erroString"A senha não funcionou, então não foi possível abrir"

Exemplo​

{
    "StatusCode": 200,
    "Message": {
        "TypeMessage": "200",
        "Message": "Processing succeeded"
    },
    "Analise": {
        "Status": 1,
        "IdAnalise": 36226,
        "Chave": "50828",
        "DataCadastro": "0001-01-01T00:00:00",
        "DataFinalizado": "0001-01-01T00:00:00",
        "Quantidade": 1,
        "Result": [
            {
                "Distribuidora": {
                    "MasterType": "ENEL",
                    "SubType": "enel ce"
                },
                "Qualidade": {
                    "Dados_Cliente": 2,
                    "Contas_Vencidas": 1,
                    "Descricao_Do_Faturamento": 3,
                    "Historico_De_Consumo": 3
                },
                "Caracteristicas": {
                    "Pdf": true,
                    "Grayscale": true,
                    "Digital": true
                },
                "Alertas": [
                    {
                        "Id": 10,
                        "Descricao" : "Mês de referencia está igual ao mês de vencimento"
                    }
                ],
                "Nome_Completo": "FULANO DE TAL SILVA",
                "CPF_CNPJ": "*** 327.31 ****",
                "Endereco_Completo": "RUA X, 136 - CENTRO, SÃO PAULO - SP",
                "CEP": "11790-000",
                "Cidade": "SÃO PAULO",
                "UF": "SP",
                "Numero_Instalacao": "12345",
                "Numero_Cliente": "56789",
                "Total_A_Pagar": "209.76",
                "Mes_Referencia": "05/2024",
                "Vencimento": "10/06/2024",
                "Classificacao_Unidade_Consumidora": "B1",
                "Contas_Vencidas": [
                    {
                        "vencimento": "03/2024",
                        "valor": "167.35"
                    }
                ],
                "Descricao_Do_Faturamento": [
                    {
                        "item_fatura": "Energia Ahva Fornecida TE",
                        "mes_ref": null,
                        "quantidade_kwh": "194",
                        "valor": "72.38"
                    },
                    {
                        "item_fatura": "Cip Mum Pub Pref Municipal",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "1.75"
                    },
                    {
                        "item_fatura": "SUBTOTAL FATURAMENTO",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "185.59"
                    },
                    {
                        "item_fatura": "SUBTOTAL OUTROS",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "24.17"
                    },
                    {
                        "item_fatura": "TOTAL",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "283,89"
                    }
                ],
                "Leitura_Atual": "07/05/2024",
                "Proxima_Leitura": null,
                "Tarifa_Social": true,
                "Historico_De_Consumo": [
                    {
                        "mes_ano": "MEDIA",
                        "consumo_faturado": "165"
                    },
                    {
                        "mes_ano": "ABR24",
                        "consumo_faturado": "17"
                    },
                    {
                        "mes_ano": "MAR24",
                        "consumo_faturado": "14"
                    },
                    {
                        "mes_ano": "FEV24",
                        "consumo_faturado": "14"
                    },
                    {
                        "mes_ano": "JAN24",
                        "consumo_faturado": "14"
                    }
                ],
                "Codigo_Barras": "34191094203571983293985387840009197430000020975",
                "QrCode": ["https://link", "https://link2"],
                "ImageIndex": 0,
                "Erro": ""
            }
        ]
    }
}

Status Code 400​

Não encontrado.

ParâmetroDescriçãoTipoExemplos
StatusCodeStatus da requisiçãoInt404
MessageDescrição da requisiçãoObject{"TypeMessage":"404","Message":"Analise não encontrada"}

Exemplo​

{
    "StatusCode": 404,
    "Message": {
        "TypeMessage": "404",
        "Message": "Analise não encontrada"
    }
}

Status Code 404​

Erro 404 - Url não encontrado

O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.

Status Code 500​

Erro não tratado pelo sistema.

ParâmetroDescriçãoTipoExemplos
StatusCodeStatus da requisiçãoInt500
MessageDescrição da requisiçãoObject{"TypeMessage":"500","Message":"ERRO NO SERVIDOR"}

Exemplo​

{
    "StatusCode": 500,
    "Message": {
        "TypeMessage": "500",
        "Message": "ERRO NO SERVIDOR"
    }
}