Fichiers


 

L'outil Fichiers de HubSpot est un système de gestion et de stockage de fichiers dans HubSpot. Les fichiers hébergés avec l'outil Fichiers peuvent être chargés et utilisés dans votre contenu HubSpot et externe, et associés à des fiches d'informations via l'API des engagements. Par exemple, si votre entreprise conçoit son site web à l'aide du CMS Hub, vous pouvez utiliser l'API de fichiers pour charger et stocker des éléments dans HubSpot, puis les proposer via le CMS Hub.

Vous pouvez accéder à l'outil Fichiers depuis HubSpot ou via l'API de fichiers. Découvrez ci-dessous l'API de fichiers et apprenez à charger et supprimer des fichiers. Pour une liste complète des points de terminaison de l'API de fichiers, cliquez sur l'onglet Points de terminaison ci-dessus.

Modifications de la version 3

Si vous utilisez la version précédente de cette API, la version 3 présente les modifications suivantes :

  • Vous ne pouvez pas créer de fichiers masqués. Tous les fichiers chargés via l'API seront visibles dans le tableau de bord des fichiers et le sélecteur de fichiers. Des fichiers privés et non indexables peuvent toujours être créés. 
  • Les points de terminaison qui créent ou remplacent des fichiers nécessitent des niveaux d'accès pour les fichiers. Ces niveaux d'accès sont les suivants :
    • 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. Une URL signée est nécessaire pour voir le contenu. Les moteurs de recherche ne peuvent pas indexer le fichier.
  • Les points de terminaison qui créent des fichiers permettent la détection de doublons dans le cadre des options de chargement du fichier. 
    • ENTIRE_PORTAL : recherchez un fichier dupliqué dans l'intégralité du compte.
    • EXACT_FOLDER : recherchez un fichier dupliqué 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 dupliqué est trouvé, ne chargez aucun nouveau fichier et renvoyez le doublon.
    • La détection des doublons fonctionne selon duplicateValidationScope, qui détermine la recherche d'un doublon.
    • Elle applique également duplicateValidationStrategy, qui précise ce qui se passe si un doublon est trouvé.
  • Les fichiers de listing ne renverront plus de fichiers masqués ou supprimés. Toutefois, un vaste éventail de filtres peut être appliqué. Les fichiers masqués peuvent toujours être consultés selon l'ID, mais nécessitent un nouveau domaine : files_ui_hidden.read.
  • Il n'est plus possible de charger plusieurs fichiers avec une seule demande. 
  • Les actions de mise à jour de dossier, comme le déplacement et le renommage, sont désormais asynchrones. Chaque demande renvoie un jeton qui peut être utilisé pour vérifier le statut de la modification du dossier.

Charger un fichier

Les fichiers peuvent être chargés à l'aide d'une demande 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

Obligatoire

Exemple

Description 

file

Oui


"file": {binary data}


Le fichier à charger.

folderId


Non


"folderId": 1234


L'ID du dossier dans lequel le fichier sera chargé. folderId et folderPath ne peuvent pas être définis en même temps.

folderPath Non

"folderPath": "/folder"



Le chemin du dossier dans lequel le fichier sera chargé. folderId et folderPath ne peuvent pas être définis en même temps.

fileName Non "fileName": "myImage"

Le nom du fichier. Si aucun nom n'est spécifié, un nom sera généré à partir du contenu du fichier.


charsetHunch
Non
“charsetHunch”: “UTF-8”

Un encodage défini de caractères pour le fichier chargé. Si ce champ n'est pas renseigné, il sera dérivé du fichier.
options Oui
"options": "{
  "access":  "PRIVATE",
"ttl": "P2W",
"overwrite": false,
"duplicateValidationStrategy": "NONE",
"duplicateValidationScope": "EXACT_FOLDER"
}"


La chaîne JSON représentant les options de chargement du fichier. Le seul champ obligatoire est le champ d'accès, qui contrôle la confidentialité et la possibilité d'indexer le fichier.



Supprimer un fichier

Pour supprimer un fichier, effectuez une demande 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. 

Afficher les détails d'un fichier

Pour afficher les détails d'un fichier chargé dans l'outil Fichiers, effectuez une demande 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.

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 propriétés spécifiques telles que la hauteur et la largeur.

Créer un dossier

Pour créer un dossier, effectuez une demande POST à files/v3/folders. Lors de la demande, vous pouvez inclure les champs ci-dessous. 

 

Champs

Obligatoire

Exemple

Description

name

Oui



“name”: “myFolder”


Le nom du dossier que vous souhaitez créer.

parentFolderId

Non


“parentFolderId”: 1234


L'ID du dossier parent pour le nouveau dossier que vous créez. parentFolderId et parentFolderPath ne peuvent pas être définis en même temps.

parnetFolderPath

Non


“parentFolderPath”: “/folder/otherFolder”


Le chemin du dossier parent pour le dossier que vous créez. parentFolderId et parentFolderPath ne peuvent pas être définis en même temps.

 

 

 

 

Exemple de demande

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

Cet article vous a-t-il été utile ? *
Ce formulaire est destiné à recueillir les avis sur la documentation pour les développeurs. Si vous souhaitez faire part de votre avis sur les produits HubSpot, veuillez le partager sur le forum des idéesde la communauté.