Compartilhar arquivo

GET

/documents/files/{idFile}/share

Marca um arquivo como compartilhado e devolve, no campo items, o código de compartilhamento. Com esse código, a rota de abrir arquivo compartilhado devolve um link de visualização do arquivo. O compartilhamento vale até ser removido pela rota de remover compartilhamento. Chamar esta rota para um arquivo já compartilhado não muda nada e devolve o código de novo. Arquivo inexistente devolve 400. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Arquivo compartilhado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Arquivo não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/documents/files//share' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": "Xy7kQ2mZ9pL4vR8wN3tB6cJ1dF5gH0sAe2Wq"
}

Modificado em 2026-10-13 09:47:06

Página anterior

Mover arquivo

Próxima página

Abrir arquivo compartilhado