Configuração de Webhook

Para obter o resultado da análise enviada, a AcertPix utiliza o método webhook, do qual retorna a consulta em tempo real.

Como configurar o webhook?

Para configurar o webhook, entre em contato com o time de Sucesso do Cliente, informando URL e token de segurança.

• Webhook configurado deve esperar uma requisição do tipo POST;

Exemplo

Requisição do tipo POST:

URL: webhook.cliente.com.br

Header

Identificador	Valor
Content-type	application/json
Authorization	Bearer [Valor do Token retornado na Autenticação]

Body

{
    "Status": 0,
    "AnaliseId": 0,
    "Chave": "string",
    "DataCadastro": "2024-07-02T15:16:47.066Z",
    "DataFinalizado": "2024-07-02T15:16:47.066Z",
    "Quantidade": 0,
    "Result": [
        {
            "Distribuidora": {
                "MasterType": "string",
                "SubType": "string"
            },
            "Qualidade": {
                "Dados_Cliente": 1,
                "Contas_Vencidas": 1,
                "Descricao_Do_Faturamento": 1,
                "Historico_De_Consumo": 1
            },
            "Caracteristicas": {
                "Pdf": true,
                "Grayscale": true,
                "Digital": true
            },
            "Alertas": [
                {
                    "Id": 1,
                    "Descricao" : "Mês de referência (01/01) divergente ao mês de vencimento (01/01/2025)"
                }
            ],
            "Nome_Completo": "string",
            "CPF_CNPJ": "string",
            "Endereco_Completo": "string",
            "CEP": "string",
            "Cidade": "string",
            "UF": "string",
            "Numero_Instalacao": "string",
            "Numero_Cliente": "string",
            "Total_A_Pagar": "string",
            "Mes_Referencia": "string",
            "Vencimento": "string",
            "Classificacao_Unidade_Consumidora": "string",
            "Contas_Vencidas": [
                {
                    "vencimento": "string",
                    "valor": "string"
                }
            ],
            "Descricao_Do_Faturamento": [
                {
                    "item_fatura": "string",
                    "mes_ref": "string",
                    "quantidade_kwh": "string",
                    "valor": "string"
                }
            ],
            "Leitura_Atual": "string",
            "Proxima_Leitura": "string",
            "Tarifa_Social": true,
            "Historico_De_Consumo": [
                {
                    "mes_ano": "string",
                    "consumo_faturado": "string"
                }
            ],
            "Codigo_Barras": "string",
            "QrCode": ["https://link", "https://link2"],
            "ImageIndex": 0
        }
    ]
}

IPs de NAT

Para receber os Webhooks corretamente, é necessário liberar os IPs de NAT da AcertPix no firewall da sua infraestrutura.

Caso ocorra erro no envio do webhook, após 15 minutos, nosso sistema fará uma nova tentativa de envio.