API - Gen Upload URL

POST

/upload-url

Endpoint para gerar uma URL para envio de informações adicionais em forma de arquivo.

Essa rota retorna a URL e os Headers que devem ser passados para um PUT request com o arquivo que será enviado

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

{
    "fileType": "PDF",
    "fileName": "path/to/file",
    "identificadorEnvio": "test"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/upload-url' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileType": "PDF",
    "fileName": "path/to/file",
    "identificadorEnvio": "test"
}'

Respostas

🟢200Criado

application/json

Claims successfuly received

Body

Exemplo

{
    "mensagem": "Signed URL criada com sucesso",
    "dataProcessamento": "2025-11-01T14:56:11.625Z",
    "signedURL": {
        "url": "https://great-pasta.com.pt/",
        "expiresInMinutes": 10,
        "requiredHeaders": "{\"Content-Type\": \"application/pdf\"}",
        "curl": "curl -X PUT \"https://storage.googleapis.com/bucket\" -H \"Content-Type: application/pdf\"--data-binary @./claim_1234.pdf"
    }
}

🟠400Pedido inválido

🟠422Erro de parâmetro

🔴500Erro do servidor

Modificado em 2026-01-09 16:26:35