POST
/
v1
/
file-links
curl --request POST \
  --url https://api.base39.io/v1/file-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expires": 123,
  "method": "download",
  "methodData": {
    "file": "file_631f61201fc21101870d22a9"
  },
  "metadata": {}
}'
{
  "id": "link_63eb84cc5ebbf96915062ecb",
  "expires": 123,
  "url": "https://files.base39.io/links/497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "method": "download",
  "methodData": {
    "file": "file_631f61201fc21101870d22a9"
  },
  "expired": true,
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-content-md5
string

Para link de Upload, enviar o resumo MD5 de 128 bits codificados em base64 do arquivo de acordo com a RFC 1864

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Body

application/json

Criar um link de arquivo

​
expires
number
required

Tempo em segundos em que o link expira.

​
method
enum<string>
default:download
required
Available options:
download,
upload
​
methodData
object
required
​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Response

201 - application/json
Retorna o objeto `FileLink` se a criação for bem-sucedida; retorna erro se os parâmetros forem inválidos.

Este objeto representa um link de arquivo.

​
id
string

Identificador exclusivo para o objeto.

Example:

"link_63eb84cc5ebbf96915062ecb"

​
expires
number

Tempo em segundos em que o link expira.

​
url
string

A URL acessível publicamente para baixar ou enviar o arquivo.

Example:

"https://files.base39.io/links/497f6eca-6276-4993-bfeb-53cbbbba6f08"

​
method
enum<string>
default:download
Available options:
download,
upload
​
methodData
object
​
expired
boolean

Se este link já expirou.

​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

​
createdAt
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
createdBy
object
​
updatedBy
object