Webhook - Análise

POST

{URL_CLIENTE}

Envia o resultado da análise das contas enviadas através da rota de contas. Essa API deve ser implementada pela operadora.

A autenticação é feita através de HMAC da seguinte forma:

A Arvo fornece uma API Key (chave pública) e um Secret Key chave privada

O cliente deve passar no request 3 headers:
a. X-API-Key - deve ser a API Key fornecida
b. X-Timestamp - UNIX timestamp do momento em que a requisição é disparada
c. X-Signature - base64 encoded de HMAC (usando sha256) bytes[API Key + timestamp + identificadorEnvio]. Será utilizado o identificadorEnvio do primeiro elemento do array de resposta.

No servidor, iremos assinar a requisição de forma análoga e verificar se o timestamp está no intervalo de 10 minutos (caso tenha passado, a autenticação irá falhar)

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/json

Exemplo

[
    {
        "dadosEnvio": {
            "identificadorEnvio": "string",
            "nomeOperadora": "string"
        },
        "dadosGuia": {
            "identificadorGuia": "string",
            "numeroLote": "string",
            "numeroGuia": "string",
            "dataPagamento": "2019-08-24T14:15:22Z"
        },
        "glosaArvo": {
            "agente": "string",
            "justificativa": "string",
            "valorGlosado": 0,
            "quantidadeGlosada": 0,
            "glosaAns": {
                "motivo": "string",
                "tipo": "string"
            },
            "categoriaAnalise": "AUT"
        },
        "itens": [
            {
                "idArvo": "string",
                "identificadorItem": "string",
                "categoria": "DIARIA",
                "sequencialItem": 0,
                "codigo": "string",
                "codigoTabela": "string",
                "identificadorPacote": "string",
                "descricao": "string",
                "viaAcesso": "UNICA",
                "grauParticipacao": "CIRURGIAO",
                "glosaArvo": {
                    "agente": "string",
                    "justificativa": "string",
                    "valorGlosado": 0,
                    "quantidadeGlosada": 0,
                    "glosaAns": {
                        "motivo": "string",
                        "tipo": "string"
                    },
                    "categoriaAnalise": "AUT"
                },
                "identificadorExecutante": "string",
                "senhaAutorizacao": "string"
            }
        ],
        "dadosExecutante": {
            "identificadorExecutante": "string"
        }
    }
]

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "dadosEnvio": {
            "identificadorEnvio": "string",
            "nomeOperadora": "string"
        },
        "dadosGuia": {
            "identificadorGuia": "string",
            "numeroLote": "string",
            "numeroGuia": "string",
            "dataPagamento": "2019-08-24T14:15:22Z"
        },
        "glosaArvo": {
            "agente": "string",
            "justificativa": "string",
            "valorGlosado": 0,
            "quantidadeGlosada": 0,
            "glosaAns": {
                "motivo": "string",
                "tipo": "string"
            },
            "categoriaAnalise": "AUT"
        },
        "itens": [
            {
                "idArvo": "string",
                "identificadorItem": "string",
                "categoria": "DIARIA",
                "sequencialItem": 0,
                "codigo": "string",
                "codigoTabela": "string",
                "identificadorPacote": "string",
                "descricao": "string",
                "viaAcesso": "UNICA",
                "grauParticipacao": "CIRURGIAO",
                "glosaArvo": {
                    "agente": "string",
                    "justificativa": "string",
                    "valorGlosado": 0,
                    "quantidadeGlosada": 0,
                    "glosaAns": {
                        "motivo": "string",
                        "tipo": "string"
                    },
                    "categoriaAnalise": "AUT"
                },
                "identificadorExecutante": "string",
                "senhaAutorizacao": "string"
            }
        ],
        "dadosExecutante": {
            "identificadorExecutante": "string"
        }
    }
]'

Respostas

🟢201Criado

application/json

Contas médicas com apontamentos recebidas com sucesso

Body

Exemplo

{}

🟠400Pedido inválido

🔴500Erro do servidor

Modificado em 2025-11-18 16:45:48