Archivos

 

ResumenPuntos finales

La herramienta Archivos de HubSpot es un sistema para administrar y almacenar archivos en HubSpot. Los archivos alojados en la herramienta de archivos se pueden cargar y usar en tu contenido de HubSpot y el contenido externo, además de adjuntos a registros usando la API de interacciones. Por ejemplo, si tu empresa está creando su sitio web usando HubSpot CMS, puedes usar la API de archivos para cargar y almacenar materiales en HubSpot, y luego hacerlo mediante el CMS de HubSpot.

Puedes acceder a la herramienta archivos desde HubSpot o usando la API de archivos. A continuación, aprende sobre los archivos API y cómo cargar y eliminar archivos. Para una lista completa de puntos finales de API de archivos, haz clic en la pestaña Puntos finales arriba.

Cambios en V3

Si usas la versión anterior de esta API, v3 tiene los siguientes cambios:

  • No puedes crear archivos ocultos. Todos los archivos cargados a través de la API serán visibles en el panel de archivos y el selector de archivos. Aún se pueden crear archivos privados y archivos no indexados. 
  • Los puntos finales que crean o reemplazan archivos requieren que proporciones niveles de acceso para los archivos. Estos niveles de acceso son:
    • PUBLIC_INDEXABLE: el archivo es accesible públicamente por cualquiera que tenga la URL. Los motores de búsqueda pueden indexar el archivo.
    • PUBLIC_NOT_INDEXABLE: el archivo es accesible públicamente por cualquiera que tenga la URL. Las X-Robots-Tag: el encabezado noindex se enviará cada vez que se recupere el archivo, indicando a los motores de búsqueda que no indexen el archivo.
    • PRIVATE: el archivo no es accesible al público. Requiere una URL firmada para ver el contenido. Los motores de búsqueda no pueden indexar el archivo.
  • Los puntos finales que crean archivos permiten un nivel de detecciones duplicadas como parte de las opciones de carga del archivo. 
    • ENTIRE_PORTAL: busca un archivo duplicado en toda la cuenta.
    • EXACT_FOLDER: busca un archivo duplicado en la carpeta proporcionada.
    • NONE: no ejecutes ninguna validación duplicada.
    • REJECT: rechaza la carga si se encuentra un duplicado.
    • RETURN_EXISTING: si se encuentra un archivo duplicado, no cargues un nuevo archivo y devuelve el duplicado encontrado en su lugar.
    • La detección duplicada funciona en duplicateValidationScope, que afecta cómo buscamos un duplicado.
    • también lleva a cabo duplicateValidationStrategy, lo que determina qué sucede si se encuentra un duplicado.
  • Los archivos de listado ya no devolverán los archivos ocultos o eliminados. Sin embargo, se puede aplicar un rango mucho más amplio de filtros. Los archivos ocultos aún se pueden recuperar por ID, pero requieren un nuevo alcance: files_ui_hidden.read.
  • Los múltiples archivos ya no se pueden cargar con una sola solicitud. 
  • Las acciones de actualización de carpeta como mover y cambiar el nombre son ahora asíncronas. Cada solicitud devolverá un token que se puede usar para comprobar el estado de la edición de la carpeta.

Cargar un archivo

Los archivos se pueden cargar usando una solicitud multipart/form-data POST para files/v3/files con los siguientes campos. Si bien un ID de carpeta específico no es obligatorio en la carga, se recomienda cargar archivos en una carpeta y no en el directorio raíz. Los requisitos de carpeta en la carga están sujetos a cambios en el futuro. 

Campo

Requerido

Ejemplo

Descripción 

file

Sí


"file": {binary data}


El archivo para cargar.

folderId


No


"folderId": 1234


El ID de la carpeta en que se cargará al archivo. folderId y folderPath no se puede establecer al mismo tiempo.
folderPath No

"folderPath": "/folder"

La ruta de la carpeta en que se cargará al archivo. folderId y folderPath no se puede establecer al mismo tiempo.
fileName No "fileName": "myImage"

El nombre del archivo. Si no se especifica ningún nombre, se generará un nombre a partir del contenido del archivo.


charsetHunch		 No
“charsetHunch”: “UTF-8”
Codificación de conjunto de caracteres para el archivo cargado. Si no se proporciona, se obtendrá del archivo.
options Sí
"options": "{
  "access":  "PRIVATE",
"ttl": "P2W",
"overwrite": false,
"duplicateValidationStrategy": "NONE",
"duplicateValidationScope": "EXACT_FOLDER"
}"

Cadena JSON que representa opciones de carga de archivos. El único campo obligatorio es el campo de acceso, que controla la privacidad y la capacidad de entrada del archivo.



Eliminar un archivo

Para eliminar un archivo, haz una solicitud DELETE a files/v3/files/{fileId}. Esto marcará el archivo como eliminado y hará que el contenido del archivo sea accesible. Para eliminar permanentemente un archivo, haz una solicitud DELETE a files/v3/files/{fileId}/gdpr-delete. Esto eliminará permanentemente el contenido y los metadatos del archivo en 7 días. 

Si no se elimina el RGPD, su contenido permanecerá en los servidores de HubSpot en un estado privado donde nadie puede acceder a él. Para garantizar que el contenido del archivo se elimine completamente, usa la funcionalidad de eliminación de RGPD. 

Ver los detalles del archivo

Para ver los detalles de un archivo que se ha cargado en la herramienta de archivos, realiza una solicitud GET a files/v3/files/{fileId}. Esto devolverá el archivo con detalles como nombre, alto y ancho, codificación, URL y más.

Si un archivo está establecido como privado, la URL devuelta ocasionará un error 404. Para obtener una URL visible del archivo, puedes hacer una solicitud GET a /files/v3/files/{fileId}/signed-url. Al realizar esta solicitud, puedes incluir parámetros de propiedad para devolver propiedades específicas como alto y ancho.

Crear una carpeta

Para crear una carpeta, haz una solicitud POST a files/v3/folders. Al realizar la solicitud, puedes incluir los siguientes campos. 

 

Campos

Requerido

Ejemplo

Descripción

name

Sí

“name”: “myFolder”


Nombre de la carpeta que deseas crear.

parentFolderId

No
“parentFolderId”: 1234


El ID de la carpeta principal para la nueva carpeta que estás creando. parentFolderId y parentFolderPath no se puede establecer al mismo tiempo.

parnetFolderPath

No
“parentFolderPath”: “/folder/otherFolder”


La ruta de la carpeta principal de la carpeta que estás creando. parentFolderId y parentFolderPath no se puede establecer al mismo tiempo.

 

 

  

 

Solicitud de ejemplo

JSON 
//example request
{
"name": "myNewFolder",
"parentFolderId": 12345
}
¿Te resultó útil este artículo? *
Con este formulario puedes enviar tu opinión sobre nuestros documentos para desarrolladores. Si tienes comentarios sobre el producto de HubSpot, puedes enviarlos al Foro de ideas.