Arquivos


 

Use a ferramenta de arquivos da HubSpot para gerenciar e armazenar arquivos no HubSpot. Os arquivos hospedados na HubSpot podem ser carregados e usados no HubSpot e no conteúdo externo. Eles também podem ser anexados a registros usando a API de envolvimentos.

Se sua empresa estiver criando um site com o HubSpot CMS, você pode usar a API dos arquivos para fazer upload e armazenar os ativos no HubSpot, em seguida, tratá-la pelo HubSpot CMS.

Você pode acessar a ferramenta de arquivos no HubSpot ou usar a API de arquivos. Veja abaixo sobre os arquivos de API e como carregar e excluir arquivos. Para obter uma lista completa de endpoints da API de arquivos, clique na guia Endpoints acima.

Alterações na V3

Se estiver usando a versão anterior desta API, a v3 tem as seguintes alterações:

  • Todos os arquivos carregados através da API estarão visíveis no painel de arquivos e no seletor de arquivos. Não é possível criar arquivos ocultos. No entanto, arquivos privados e não indexáveis ainda podem ser criados. 
  • Os arquivos de listagem não retornam arquivos ocultos ou excluídos. No entanto, uma grande variedade de filtros pode ser aplicada. Arquivos ocultos ainda podem ser buscados por ID, mas exigem um novo escopo: files_ui_hidden.read.
  • Vários arquivos não podem ser carregados com uma única solicitação. 
  • Ações de atualização de pasta, como mover e renomear, são agora assíncronas. Cada solicitação retornará um token que pode ser usado para verificar o status da edição da pasta.
  • Endpoints que criam ou substituem arquivos exigem o fornecimento de níveis de acesso para os arquivos. Esses níveis de acesso são:
    • PUBLIC_INDEXABLE: o arquivo está acessível publicamente a qualquer um que tenha o URL. Os mecanismos de pesquisa podem indexar o arquivo.
    • PUBLIC_NOT_INDEXABLE: o arquivo está acessível publicamente a qualquer um que tenha o URL. O cabeçalho X-Robots-Tag: noindex será enviado sempre que o arquivo for recuperado, instruindo aos mecanismos de pesquisa que não indexem o arquivo.
    • PRIVATE: o arquivo não está acessível publicamente. Requer um URL assinado para exibir o conteúdo. Os mecanismos de pesquisa não podem indexar o arquivo.
  • Endpoints que criam arquivos possibilitam um nível de pontuações duplicadas como parte das opções de upload do arquivo. 
    • ENTIRE_PORTAL: procure um arquivo duplicado na conta.
    • EXACT_FOLDER: procura um arquivo duplicado na pasta fornecida.
    • NONE: não execute qualquer validação de arquivos duplicados.
    • REJECT: rejeite o upload se um arquivo duplicado for encontrado.
    • RETURN_EXISTING: se um arquivo duplicado for encontrado, não faça o upload de um novo arquivo, retorne o encontrado.
    • A detecção de duplicata funciona em duplicateValidationScope, o que afeta como procurar uma duplicata.
    • Isso também exige um duplicateValidationStrategy, que instrui o que acontece se um arquivo duplicado for encontrado.

Upload de um arquivo

O upload dos arquivos pode ser feita usando uma solicitação POST multipart/form-data para files/v3/files com os seguintes campos. Embora um ID de pasta específico não seja necessário para upload, recomendamos fazer upload dos arquivos em uma pasta e não no diretório raiz. Os requisitos da pasta para upload estão sujeitos a alterações futuras. 

Use this table to describe parameters / fields
CampoObrigatórioDescription Example
file
Yes

O arquivo para upload.

"file": {binary data}
options
Yes

As opções de carregamento do arquivo. O único campo obrigatório é o de access, que controla a privacidade e indexabilidade do arquivo.

Se estiver usando o campo ttl:

  • O período mínimo que deve ser definido é de um (1) dia. 
  • O período máximo que pode ser definido é de um (1) ano. 
  • Após o período definido, o arquivo será excluído permanentemente. Após a exclusão, o arquivo não poderá ser recuperado ou restaurado.

"options": "{ "access":  "PRIVATE", "ttl": "P2W", "overwrite": false, "duplicateValidationStrategy": "NONE", "duplicateValidationScope": "EXACT_FOLDER" }"
folderId
No

O ID da pasta em que o upload do arquivo será feito. folderId e folderPath não podem ser definidos ao mesmo tempo.

"folderId": 1234
folderPath
No

O caminho da pasta em que o upload do arquivo será feito. folderId e folderPath não podem ser definidos ao mesmo tempo.

"folderPath": "/folder"
fileName
No

O nome do arquivo. Se nenhum nome for especificado, um nome será gerado do conteúdo do arquivo.

"fileName": "myImage"
charsetHunch
No

Rótulo do conjunto de caracteres do arquivo de upload. Se não for fornecido, ele será derivada do arquivo.

"charsetHunch": "UTF-8"

Excluir um arquivo

Para excluir um arquivo, faça uma solicitação DELETE para files/v3/files/{fileId}. Isso marcará o arquivo como excluído e tornará o conteúdo do arquivo inacessível.

Para excluir permanentemente um arquivo, faça uma solicitação DELETE para files/v3/files/{fileId}/gdpr-delete. Isso excluirá permanentemente o conteúdo e os metadados do arquivo em até 7 dias. 

Se um arquivo não for excluído de acordo com o GDPR, o conteúdo dele permanecerá nos servidores do HubSpot em um estado privado onde ninguém poderá acessá-lo. Para garantir que o conteúdo do arquivo seja totalmente excluído, use a funcionalidade de exclusão do GDPR. 

Exibir detalhes do arquivo

Para exibir os detalhes de um arquivo que foi enviado por upload para a ferramenta de arquivos, faça uma solicitação GET para files/v3/files/{fileId}. Isso retornará o arquivo com detalhes, como nome, altura e largura, codificação, URL e muito mais.

Se um arquivo for definido como privado, o URL retornado resultará em um erro 404. Para obter uma URL visível do arquivo, você pode fazer uma solicitação GET para /files/v3/files/{fileId}/signed-url. Ao fazer essa solicitação, você pode incluir parâmetros property para retornar propriedades específicas, como altura e largura.

Criar uma pasta

Para criar uma pasta, faça uma solicitação POST para files/v3/folders. Ao fazer a solicitação, você pode incluir os campos abaixo. 

Use this table to describe parameters / fields
CampoObrigatórioDescription Example
name
Yes

Nome da pasta que você deseja criar.

"name": "myFolder"
parentFolderId
No

Para criar a pasta dentro de uma pasta existente, inclua este campo com o ID da pasta existente. parentFolderId e parentFolderPath não podem ser definidos ao mesmo tempo.

"parentFolderId": 1234
parentFolderPath
No

Para criar a pasta dentro de uma pasta existente, inclua este campo com o caminho da pasta existente. parentFolderId e parentFolderPath não podem ser definidos ao mesmo tempo.

"folderId": 1234

Exemplo de solicitação

JSON
//example request
{
"name": "myNewFolder",
"parentFolderId": 12345
}

Este artigo foi útil?
Este formulário deve ser usado apenas para fazer comentários sobre esses artigos. Saiba como obter ajuda para usar a HubSpot..