# API: Files --- - [Introdução](#intro) - [Upload](#upload) ## Introdução As rotas descritas abaixo são responsáveis pelo upload e pelo acesso a arquivos privados no servidor. A API está configurada para interpretar qualquer entidade que contenha uma propriedade com o sufixo '_file' como responsável por armazenar o caminho de um arquivo no armazenamento. Ao salvar uma entidade que contenha um desses campos, o sufixo '_file' deve ser substituído por '_temp' no corpo da requisição. O campo com sufixo '_temp' receberá o 'file_name' contido na resposta do endpoint de upload. Exemplo: `profile_picture_file` deve se alterado para `profile_picture_temp`. Internamente, ao salvar um campo com o sufixo '_temp', a API move o arquivo de um diretório temporário para um diretório permanente e, automaticamente, atribui o caminho do arquivo movido ao campo '_file' correspondente. ## Upload ### Endpoint |Método|URI|Headers| |:|:-|:| |POST|`/file-upload`|

Content-Type: multipart/form-data

| ### Body ```json file: , code: string(optional) ``` ### Responses 200 - OK ```json { "file_name": , "url": , "code":


}
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```


## Get Private Files

Este endpoint não pode ser acessado diretamente pelos consumidores da API, pois exige uma assinatura. Ou seja, a própria API é responsável por gerar a URL assinada, que autoriza o acesso. Esse recurso é especialmente utilizado para fornecer URLs de acesso a arquivos associados aos campos '_file'.

\* Este endpoint não está no path `/api`

### Endpoint
|Método|URI|Headers|
|:|:-|:|
|GET|`/private-storage//?signature=`|Default|

### Body
```json
Empty
```

### Responses
200 - OK
```json
***file***
```

401 - Unauthorized
```json
{
    "message": "Unauthenticated."
}
```