Les points de terminaison des fichiers sont utilisés pour obtenir et gérer des données dans votre gestionnaire de fichiers.
POST
multipart/form-data à files/v3/files
avec les champs suivants. Si un ID de dossier spécifique n’est pas requis lors du chargement, il est recommandé de charger des fichiers dans un dossier et non dans le répertoire racine. Les exigences de dossier lors du chargement peuvent changer à l’avenir.
Champ | Description |
---|---|
file | Le fichier à charger (obligatoire). |
options | Un objet JSON qui contrôle la confidentialité et l’indexabilité du fichier et contient deux champs : access , qui est obligatoire, et ttl , qui indique une période après laquelle le fichier sera automatiquement supprimé. Si vous utilisez le champ ttl :
|
folderId | L’ID du dossier dans lequel le fichier sera téléchargé. Ce champ ou folderPath doit être fourni dans votre demande (mais pas les deux). |
folderPath | Le chemin du dossier dans lequel le fichier sera téléchargé. Ce champ ou folderId doit être fourni dans votre demande (mais pas les deux). |
fileName | Le nom du fichier. Si aucun nom n’est spécifié, un nom sera généré à partir du contenu du fichier. |
charsetHunch | Un encodage défini de caractères pour le fichier chargé. Si ce champ n’est pas renseigné, il sera dérivé du fichier. |
cat.png
/library/cat_archive
id
et parentFolderId
du fichier téléchargé, que vous pouvez utiliser pour récupérer le fichier via une demande GET.
POST
vers files/v3/files/import-from-url/async
, vous pouvez consulter le statut de téléchargement du fichier.
Pour ce faire, effectuez une demande GET
vers files/v3/files/import-from-url/async/tasks/{taskId}/status
.
Après avoir fait cette demande, vous recevrez l’une des réponses suivantes :
PENDING
: le fichier est dans la file d’attente pour être téléchargé. Le processus d’import n’a pas encore commencé.PROCESSING
: le fichier est en cours de téléchargement.CANCELED
: le téléchargement a été annulé et le fichier ne sera pas téléchargé. Pour importer le fichier dans votre compte HubSpot, vous devrez le télécharger à nouveau.COMPLETE
: le fichier a correctement été téléchargé vers l’outil Fichiers. Le fichier téléchargé apparaîtra dans votre outil Fichiers.GET
à files/v3/files/{fileId}
. Cela renverra le fichier avec des informations telles que le nom, la hauteur et la largeur, l’encodage ou encore l’URL.
Par exemple, pour récupérer les détails d’un fichier :
Si un fichier est défini comme privé, l’URL renverra une erreur 404. Pour obtenir une URL visible du fichier, vous pouvez effectuer une demande GET
à /files/v3/files/{fileId}/signed-url
. Lors de cette demande, vous pouvez inclure des paramètres property
pour renvoyer des spécifiques telles que la hauteur et la largeur.
DELETE
à files/v3/files/{fileId}
. Le fichier sera marqué comme supprimé et son contenu sera inaccessible.
Pour supprimer définitivement un fichier, effectuez une demande DELETE
à files/v3/files/{fileId}/gdpr-delete
. Le contenu et les métadonnées du fichier seront définitivement supprimés sous 7 jours.
Si un fichier n’est pas supprimé conformément au RGPD, son contenu restera sur les serveurs de HubSpot avec un statut privé et personne ne pourra y accéder. Pour assurer la suppression complète du contenu du fichier, utilisez la fonctionnalité de suppression conformément au RGPD.
POST
à files/v3/folders
. Lors de la demande, vous pouvez inclure les champs ci-dessous.
Champ | Obligatoire | Description |
---|---|---|
name | Oui | : le nom du dossier que vous souhaitez créer. |
parentFolderId | Non | : pour créer le dossier dans un dossier existant, incluez ce champ avec l’ID du dossier existant. parentFolderId et parentFolderPath ne peuvent pas être définis en même temps. |
parentFolderPath | Non | : pour créer le dossier dans un dossier existant, incluez ce champ avec le chemin du dossier existant. parentFolderId et parentFolderPath ne peuvent pas être définis en même temps. |
files_ui_hidden.read.
PUBLIC_INDEXABLE
** :** le fichier est accessible publiquement par toute personne disposant de l’URL. Les moteurs de recherche peuvent indexer le fichier.PUBLIC_NOT_INDEXABLE
** :** le fichier est accessible publiquement par toute personne disposant de l’URL. X-Robots-Tag : l’en-tête non indexable sera envoyé lors de la récupération du fichier et les moteurs de recherche n’indexeront pas le fichier.PRIVATE
: le fichier n’est pas accessible publiquement. Nécessite une URL signée pour afficher le contenu. Les moteurs de recherche ne peuvent pas indexer le fichier.ENTIRE_PORTAL
** :** permet de rechercher un fichier en double dans le compte.EXACT_FOLDER
** :** permet de rechercher un fichier en double dans le dossier indiqué.NONE
** :** n’exécutez aucune vérification de doublon.REJECT
** :** rejetez le chargement si un doublon est trouvé.RETURN_EXISTING
** :** si un fichier en double est trouvé, ne chargez aucun nouveau fichier et renvoyez le doublon.duplicateValidationScope
, qui détermine la recherche d’un doublon.duplicateValidationStrategy
, qui précise ce qui se passe si un doublon est trouvé.