Descarregar PDF documentos

A presente página descreve as rotas necessárias para a obtenção de um PDF de um documento

De modo a descarregar o PDF de um documento, deverá realizar um pedido à seguinte rota

curl -v -X GET -H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/json' -H \
'Authorization: Bearer <access_token>' \
'<API_URL>/url_for_print/<document_id>?filter[type]=Document&filter[copies]=1'

GET/url_for_print

Response

200

OK

Body

application/json

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/url_for_print', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "type": "url_for_print",
    "attributes": {},
    "relationships": {}
  }
}

Tal como nos restantes pedidos especificados anteriormente, o <access_token> corresponde ao token de acesso válido devolvido pelo serviço de OAuth

Após a realização deste pedido, irá receber uma resposta do tipo:

{
    "data": {
        "type": "url_for_print",
        "id": "received_id",
        "attributes": {
            "url": {
                "scheme": "https",
                "host": "app.cloudware.pt",
                "port": 443,
                "path": "/public-file/path_to_file"
            }
        }
    }
}

Utilizando a resposta recebida, deverá concatenar os atributos: scheme + "://" + host + path, e irá obter o link através do qual a transferência é imediata. Neste caso, seria:

https://app.cloudware.pt/public-file/path_to_file