API do CMS | Gerenciador de arquivos

​

Upload de um arquivo

• Nome de arquivo: cat.png
• Pasta de destino no gerenciador de arquivos do HubSpot: /library/cat_archive
• Acessibilidade dos arquivos no HubSpot: acesso privado

curl --request POST \
  --url 'https://api.hubapi.com/files/v3/files?=' \
  --header 'Authorization: Bearer pat-na1-00000000-0000-0000-0000-000000000000' \
  --header 'Content-type: multipart/form-data' \
  --form file=@/Users/person/Downloads/cat.png \
  --form 'options={"access": "PRIVATE"}' \
  --form folderPath=/library/cat_archive

// 201 Response from successful file upload
{
  "id": "122692044085",
  "createdAt": "2023-06-28T17:56:45.393Z",
  "updatedAt": "2023-06-28T17:56:45.393Z",
  "archived": false,
  "parentFolderId": "122692510820",
  "name": "cat",
  "path": "/library/cat_archive/cat.png",
  "size": 24574,
  "height": 219,
  "width": 225,
  "encoding": "png",
  "type": "IMG",
  "extension": "png",
  "defaultHostingUrl": "https://12345.fs1.hubspotusercontent-na1.net/hubfs/12345/library/cat_archive/cat.png",
  "url": "https://12345.fs1.hubspotusercontent-na1.net/hubfs/12345/library/cat_archive/cat.png",
  "isUsableInContent": true,
  "access": "PRIVATE"
}

​

Verificar o estado de carregamento de um arquivo

• PENDING: o arquivo está na fila para ser carregado. O processo de importação ainda não foi iniciado.
• PROCESSING: o arquivo está em processo de carregamento.
• CANCELED: o carregamento foi cancelado e o arquivo não será carregado. Para importar o arquivo na sua conta da HubSpot, você precisará carregar o arquivo novamente.
• COMPLETE: o arquivo foi carregado para a ferramenta de arquivos com sucesso. O arquivo carregado aparecerá na ferramenta de arquivos.

​

Exibir detalhes do arquivo

​

Excluir um arquivo

​

Criar uma pasta

//Example request body of POST request to /files/v3/folders
{
  "name": "myNewFolder",
  "parentFolderId": 12345
}

​

Alterações na V3

• 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.
• Pontos de extremidade 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.
• Pontos de extremidade 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 duplicados funciona em duplicateValidationScope, o que afeta como procuramos um objeto duplicado.
  • Isso também exige um duplicateValidationStrategy, que instrui o que acontece se um arquivo duplicado for encontrado.