API - Feedback

POST

/feedback

API para recebimento do status das críticas arvo enviadas a 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]

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"
        },
        "dadosGuia": {
            "identificadorGuia": "string",
            "numeroGuia": "string",
            "numeroLote": "string",
            "fontePagadora": "string",
            "cancelada": true
        },
        "itens": [
            {
                "idArvo": "string",
                "identificadorItem": "string",
                "status": {
                    "registrado": 0
                },
                "motivoStatus": "string"
            }
        ]
    }
]

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/feedback' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "dadosEnvio": {
            "identificadorEnvio": "string",
            "nomeOperadora": "string"
        },
        "dadosGuia": {
            "identificadorGuia": "string",
            "numeroGuia": "string",
            "numeroLote": "string",
            "fontePagadora": "string",
            "cancelada": true
        },
        "itens": [
            {
                "idArvo": "string",
                "identificadorItem": "string",
                "status": {
                    "registrado": 0
                },
                "motivoStatus": "string"
            }
        ]
    }
]'

Respostas

🟢201Criado

application/json

Body

Exemplo

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

🟠400Pedido inválido

🟠422Erro de parâmetro

Modificado em 2025-11-18 16:38:43