API - Autorizacao

POST

/authorization

Recepciona as autorizações de contas médicas.

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]

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 Bodyapplication/json

Exemplo

{
    "dadosEnvio": {
        "identificadorEnvio": "string",
        "nomeOperadora": "string"
    },
    "autorizacoes": [
        {
            "dadosAutorizacao": {
                "senhaAutorizacao": "string",
                "autorizacaoPrincipal": "string",
                "statusAutorizacao": "CONCLUIDO",
                "tipoFinalizacao": "AUTOMATICA",
                "dataSolicitacao": "2019-08-24T14:15:22Z",
                "dataEmissao": "2019-08-24T14:15:22Z",
                "dataValidade": "2019-08-24T14:15:22Z"
            },
            "dadosAtendimento": {
                "caraterAtendimento": "ELETIVO"
            },
            "dadosBeneficiario": {
                "identificador": "string"
            },
            "dadosExecutante": {
                "identificador": "string"
            },
            "itens": [
                {
                    "identificadorItem": "string",
                    "codigoTabela": "SIMPRO",
                    "codigo": "string",
                    "descricao": "string",
                    "categoria": "DIARIA",
                    "quantidadeSolicitada": 1,
                    "quantidadeAutorizada": 0,
                    "valorSolicitado": 1,
                    "valorAutorizado": 0,
                    "tipoNegativa": "string"
                }
            ]
        }
    ]
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/authorization' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dadosEnvio": {
        "identificadorEnvio": "string",
        "nomeOperadora": "string"
    },
    "autorizacoes": [
        {
            "dadosAutorizacao": {
                "senhaAutorizacao": "string",
                "autorizacaoPrincipal": "string",
                "statusAutorizacao": "CONCLUIDO",
                "tipoFinalizacao": "AUTOMATICA",
                "dataSolicitacao": "2019-08-24T14:15:22Z",
                "dataEmissao": "2019-08-24T14:15:22Z",
                "dataValidade": "2019-08-24T14:15:22Z"
            },
            "dadosAtendimento": {
                "caraterAtendimento": "ELETIVO"
            },
            "dadosBeneficiario": {
                "identificador": "string"
            },
            "dadosExecutante": {
                "identificador": "string"
            },
            "itens": [
                {
                    "identificadorItem": "string",
                    "codigoTabela": "SIMPRO",
                    "codigo": "string",
                    "descricao": "string",
                    "categoria": "DIARIA",
                    "quantidadeSolicitada": 1,
                    "quantidadeAutorizada": 0,
                    "valorSolicitado": 1,
                    "valorAutorizado": 0,
                    "tipoNegativa": "string"
                }
            ]
        }
    ]
}'

Respostas

🟢201Criado

application/json

Claims successfuly received

Body

Exemplo

{
    "message": "string",
    "received_at": "2019-08-24T14:15:22Z"
}

🟠400Pedido inválido

🟠422Erro de parâmetro

🔴500Erro do servidor

Modificado em 2025-11-18 16:41:03