Arquivos


 

A ferramenta de arquivos do HubSpot é um sistema para gerenciar e armazenar arquivos no HubSpot. Você pode fazer upload e usar os arquivos hospedados com a ferramenta de arquivos e no HubSpot e em conteúdo externo, bem como anexados aos registros usando a API de engajamento. Por exemplo, se sua empresa estiver construindo um site com o CMS do HubSpot, você pode usar os arquivos API para fazer upload e armazenar ativos no HubSpot, e servi-los pelo CMS do HubSpot.

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 uma lista completa de arquivos 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:

  • Você não pode criar arquivos ocultos. Todos os arquivos carregados através da API estarão visíveis no painel de arquivos e no seletor de arquivos. Arquivos privados e não indexáveis ainda podem ser criados. 
  • 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 ver 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: procura um arquivo duplicado na conta inteira.
    • EXACT_FOLDER: procura um arquivo duplicado na pasta fornecida.
    • NONE: não executa qualquer validação de duplicata.
    • REJECT: rejeita o carregamento se for encontrado uma duplicata.
    • RETURN_EXISTING: se um arquivo duplicado for encontrado, não faz upload de um novo arquivo e retorna a duplicata encontrada.
    • A detecção de duplicata funciona em duplicateValidationScope, o que afeta como procurar uma duplicata.
    • Ela também tem um duplicateValidationStrategy, que instrui o que acontece se uma duplicata for encontrada.
  • Os arquivos de listagem não retornam mais 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.
  • Não é mais possível fazer upload de vários arquivos 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.

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. 

Campo

Obrigatório

Exemplo

Descrição 

file

Sim


"file": {binary data}


O arquivo para upload.

folderId


Não


"folderId": 1234


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

folderPath Não

"folderPath": "/folder"



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

fileName Não "fileName": "myImage"

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


charsetHunch
Não
“charsetHunch”: “UTF-8”

Rótulo do conjunto de caracteres do arquivo de upload. Se não for fornecido, ele será derivada do arquivo.
options Sim
"options": "{
  "access":  "PRIVATE",
"ttl": "P2W",
"overwrite": false,
"duplicateValidationStrategy": "NONE",
"duplicateValidationScope": "EXACT_FOLDER"
}"


String de JSON representando opções de upload de arquivo. O único campo obrigatório é o campo de acesso, que controla a privacidade e indexabilidade do arquivo.



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. 

 

Campos

Obrigatório

Exemplo

Descrição

name

Sim



“name”: “myFolder”


Nome da pasta que você quer criar.

parentFolderId

Não


“parentFolderId”: 1234


O ID da pasta mãe para a nova pasta que você está criando. parentFolderId e parentFolderPath não podem ser definidos ao mesmo tempo.

parnetFolderPath

Não


“parentFolderPath”: “/folder/otherFolder”


O caminho da pasta mãe para a pasta que você está criando. parentFolderId e parentFolderPath não podem ser definidos ao mesmo tempo.

 

 

 

 

Exemplo de solicitação

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

Was this article helpful? *
This form is used for documentation feedback only. Learn how to get help with HubSpot...