Fichiers
Accédez aux API et testez-les en version bêta.
Cette API est actuellement proposée en version bêta. Pour obtenir la dernière version stable, consultez ces pages : Charger un nouveau fichier, Lister les métadonnées pour tous les fichiers, Charger un fichier de remplacement, Marquer un fichier comme supprimé, Obtenir les métadonnées d'un fichier, Archiver un fichier, Supprimer définitivement un fichier et ses éléments associés, Mettre à jour l'accès d'un groupe de fichiers, Vérifier le statut d'une tâche de mise à jour de l'accès pour un fichier, Obtenir une URL signée pour un fichier privé, Déplacer un fichier, Créer un dossier, Lister les métadonnées d'un dossier, Supprimer un dossier, Obtenir le dossier selon l'ID,
Utilisez l'outil Fichiers de HubSpot pour gérer et stocker des fichiers dans HubSpot. Les fichiers hébergés dans HubSpot peuvent être chargés et utilisés dans HubSpot et dans le contenu externe. Ils peuvent également être joints à des fiches d'informations à l'aide de l'API des engagements.
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.
Si vous utilisez la version précédente de cette API, la version 3 présente les modifications suivantes :
- Tous les fichiers chargés via l'API seront visibles dans le tableau de bord des fichiers et le sélecteur de fichiers. Les fichiers cachés ne peuvent pas être créés. Cependant, les fichiers privés et non indexables peuvent toujours être créés.
- Les fichiers de listing ne renverront pas 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
. - Plusieurs fichiers ne peuvent pas être téléchargés 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.
- 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. Nécessite une URL signée pour afficher 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 en double dans le compte.EXACT_FOLDER
: recherchez 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.- 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 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 | Description | Example |
---|---|---|---|
file
| Yes | Le fichier à charger. |
"file": {binary data}
|
options
| Yes | Les options de chargement du fichier. Le seul champ obligatoire est le champ Si vous utilisez le champ
|
"options": "{
"access": "PRIVATE",
"ttl": "P2W",
"overwrite": false,
"duplicateValidationStrategy": "NONE",
"duplicateValidationScope":
"EXACT_FOLDER"
}"
|
folderId
| No | L'ID du dossier dans lequel le fichier sera chargé. |
"folderId": 1234
|
folderPath
| No | Le chemin du dossier dans lequel le fichier sera chargé. |
"folderPath": "/folder"
|
fileName
| No | Le nom du fichier. Si aucun nom n'est spécifié, un nom sera généré à partir du contenu du fichier. |
"fileName": "myImage"
|
charsetHunch
| No | Un encodage défini de caractères pour le fichier chargé. Si ce champ n'est pas renseigné, il sera dérivé du fichier. |
"charsetHunch": "UTF-8"
|
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.
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.
Champ | Obligatoire | Description | Example |
---|---|---|---|
Nom
| Yes | Le nom du dossier que vous souhaitez créer. |
"name": "myFolder"
|
parentFolderId
| No | Pour créer le dossier dans un dossier existant, incluez ce champ avec l'ID du dossier existant. |
"parentFolderId": 1234
|
parentFolderPath
| No | Pour créer le dossier dans un dossier existant, incluez ce champ avec le chemin du dossier existant. |
"folderId": 1234
|
Exemple de demande
//example request
{
"name": "myNewFolder",
"parentFolderId": 12345
}
Merci d'avoir partagé votre avis.