| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retorna uma URL temporária de acesso ao arquivo armazenado na Goalfy.
Ao consultar cards ou registros pela API, os campos do tipo arquivo retornam apenas o caminho relativo do arquivo armazenado, e não a URL completa para download.
Este endpoint permite converter esse caminho relativo em uma URL assinada e temporária, possibilitando acessar ou baixar o arquivo diretamente.
É recomendado para integrações que necessitam visualizar, baixar ou compartilhar arquivos armazenados na plataforma.
Como funciona
Ao consultar um card pela API, um campo de arquivo pode retornar um valor semelhante a:
[id do caminho relativo]/filePath
Exemplo:
cf09c6f0-c2f8-4631-bb9b-d7fa5f8bfa16/Vendas.txt
Esse valor representa apenas o caminho relativo do arquivo dentro do armazenamento da plataforma.
Para obter a URL real do arquivo, utilize este endpoint informando:
- O ID do Board onde o arquivo está armazenado.
- O caminho relativo retornado pelo campo de arquivo.
A API retornará uma URL assinada válida para acesso ao arquivo.
Parâmetros utilizados
idBoard
idBoardIdentificador único do Board onde o arquivo está vinculado.
O ID deve ser informado diretamente na rota da requisição.
filePath
filePathCaminho relativo do arquivo retornado pela API.
Este valor normalmente é obtido através de consultas de Cards ou Registros que possuam campos do tipo arquivo.
Exemplo de Requisição
GET https://api.goalfy.com.br/api/files/download/link/12345/cf09c6f0-c2f8-4631-bb9b-d7fa5f8bfa16/Vendas.txtOnde:
| Parâmetro | Valor |
|---|---|
| 12345 | ID do Board |
| cf09c6f0-c2f8-4631-bb9b-d7fa5f8bfa16/Vendas.txt | Caminho relativo do arquivo |
Exemplo de Resposta
{
"url": "https://storage.googleapis.com/goalfy-storage/users/ad063ee9-09af-469b-a0df-a9dcd6db1a7b/ad063ee9-09af-469b-a0df-a9dcd6db1a7b/arquivo.jpg?X-Goog-Algorithm=GOOG4-RSA-SHA256..."
}
Respostas esperadas
Sucesso 200Retorna uma URL assinada temporária para acesso ao arquivo solicitado.
A URL poderá ser utilizada para download, visualização ou compartilhamento do arquivo.
Possíveis erros
400 Bad RequestRetornado quando o caminho do arquivo foi informado de forma inválida.
404 Not FoundRetornado quando o arquivo informado não existe ou não foi localizado.
Também pode ocorrer quando o Board informado não corresponde ao arquivo solicitado.
401 UnauthorizedRetornado quando o token de autenticação é inválido ou não foi enviado corretamente.
403 ForbiddenRetornado quando o usuário não possui permissão para acessar o arquivo informado.
Observações
ImportanteA URL retornada é temporária e possui prazo de expiração.
- O filePath deve ser exatamente igual ao valor retornado pelo campo de arquivo.
- Não altere ou modifique o caminho relativo antes de realizar a consulta.
- A URL gerada pode expirar após determinado período de tempo.
- Caso a URL expire, basta realizar uma nova consulta neste endpoint para gerar outro link de acesso.
- O arquivo somente poderá ser acessado por usuários que possuam permissão sobre o Board correspondente.
Fluxo recomendado
- Consultar o Card ou Registro que contém o campo de arquivo.
- Obter o valor retornado pelo campo (caminho relativo).
- Identificar o ID do Board/Database relacionado ao arquivo.
- Utilizar este endpoint informando o idBoard/Database e o filePath.
- Utilizar a URL retornada para visualizar ou baixar o arquivo.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: