Los endpoints de los archivos se emplean para obtener y gestionar los datos en el administrador de archivos
POST
a files/v3/files
con los siguientes campos. Si bien no es obligatorio incluir un ID de folder específico al subir archivos, se recomienda hacerlo dentro de una carpeta en lugar de subirlos directamente al directorio principal. Los requisitos de las carpetas para subir archivos están sujetos a cambios en el futuro.
Campo | Descripción |
---|---|
file | El archivo que se va a subir (requerido). |
options | Un objeto JSON que define la privacidad e indexabilidad del archivo, y está compuesto por dos campos: access , que es necesario, y ttl , que establece un período de tiempo después del cual el archivo se eliminará automáticamente. Si utilizas el campo ttl :
|
folderId | El ID de la carpeta a la que se subirá el archivo. En tu solicitud, se debe proporcionar este campo o folderPath (pero no ambos). |
folderPath | La ruta de la carpeta en la que se subirá el archivo. En tu solicitud, se debe proporcionar este campo o folderId (pero no ambos). |
fileName | El nombre del archivo. Si no se especifica, se generará un nombre a partir del contenido del archivo. |
charsetHunch | Codificación del conjunto de caracteres para el archivo subido. Si no se proporciona, se obtendrá del archivo. |
cat.png
/library/cat_archive
id
y el parentFolderId
del archivo subido, que puedes utilizar para obtener el archivo a través de una solicitud GET.
POST
a files/v3/files/import-from-url/async
, puedes revisar el estado de subida del archivo.
Para hacerlo, usa una solicitud GET
a files/v3/files/import-from-url/async/tasks/{taskId}/status
.
Después de hacer esta solicitud, recibirás una de las siguientes respuestas:
PENDING
: el archivo está en la cola de espera para subirse. El proceso de importación aún no ha comenzado.PROCESSING
: el archivo está en proceso de subirse.CANCELED
: la subida del archivo se ha cancelado y no se completará. Para importar el archivo a tu cuenta de HubSpot, tendrás que subirlo de nuevo.COMPLETE
: el archivo se subió correctamente en la herramienta de archivos. El archivo subido aparecerá en tu herramienta de archivos.GET
a files/v3/files/{fileId}
. Esto devolverá el archivo con detalles como el nombre, el alto y el ancho, la codificación, el URL y mucho más.
Por ejemplo, para obtener los detalles de un archivo:
Si un archivo está privado, la URL devuelta generará 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 property
para obtener información de propiedades específicas como altura y anchura.
DELETE
a files/v3/files/{fileId}
. Esto marcará el archivo como eliminado y hará que el contenido del archivo no esté disponible.
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 un archivo no se elimina conforme al 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 conforme al RGPD.
POST
a files/v3/folders
. Al realizar la solicitud, puedes incluir los siguientes campos.
Campo | Obligatorio | Descripción |
---|---|---|
name | Sí | Nombre de la carpeta que quieres crear. |
parentFolderId | No | Para crear la carpeta dentro de una carpeta existente, incluye este campo con el ID de la carpeta existente. Los campos parentFolderId y parentFolderPath no se pueden definir al mismo tiempo. |
parentFolderPath | No | Para crear la carpeta dentro de una carpeta existente, incluye este campo con la ruta de la carpeta existente. Los campos parentFolderId y parentFolderPath no se pueden definir al mismo tiempo. |
files_ui_hidden.read.
PUBLIC_INDEXABLE
: el archivo se puede acceder públicamente por cualquiera que tenga la URL. Los motores de búsqueda pueden indexar el archivo.PUBLIC_NOT_INDEXABLE
: el archivo se puede acceder públicamente por cualquiera que tenga la URL. La etiqueta X-Robots: es el encabezado noindex que se enviará cada vez que se obtenga el archivo, indicando a los motores de búsqueda que no lo indexen.PRIVATE
: el archivo no se puede acceder públicamente. Requiere una URL firmada para mostrar el contenido. Los motores de búsqueda no pueden indexar el archivo.ENTIRE_PORTAL
: busca un archivo duplicado en la cuenta.EXACT_FOLDER
: busca un archivo duplicado en la carpeta proporcionada.NONE
: no ejecuta ninguna validación de duplicados.REJECT
: rechaza la subida del archivo si se encuentra un duplicado.RETURN_EXISTING
: si se encuentra un archivo duplicado, no carga un nuevo archivo. En su lugar, devuelve el duplicado encontrado.duplicateValidationScope
, que modifica cómo buscamos un duplicado.duplicateValidationStrategy
, que determina lo que sucede si se encuentra un duplicado.