Lister les styles du fichier avec l'API Figma
Liste les styles publiés depuis un fichier de bibliothèque : couleurs, texte, effets et grilles, avec key, nom, style_type, description et node_id. Les valeurs d'un style sont dans son nœud : lisez-les avec Obtenir des nœuds du fichier.
- Identifiant
- figma_list_file_styles
L'appel
POST https://connect.reportei.com/api/tools/figma_list_file_styles/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"file_key": "<file_key>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| file_key | string | Oui | Key of the library file: the part after /design/ or /file/ in the URL of the file in Figma. It must be the main file, not a branch. |
Connexions possibles
Votre client connecte son compte Figma une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/figma, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/figma_list_file_styles. Il devient la définition de tool de votre agent sans conversion.
Autres tools Figma
- Obtenir les métadonnées du fichierGETRenvoie les métadonnées d'un fichier sans son contenu : nom, dossier, type d'éditeur (Figma Design, FigJam, Slides et autres), créateur, dernier auteur de modification et date, miniature, rôle de l'utilisateur et accès par lien. Bien moins coûteux qu'Obtenir le fichier dans les limites de débit de Figma, à utiliser en premier quand la question porte sur le fichier et non sur ses calques.
- Obtenir le fichierGETRenvoie l'arbre du document d'un fichier : pages, frames et calques avec leurs propriétés et ids, ainsi que les composants et styles utilisés par le fichier. L'arbre d'un gros fichier est énorme : passez depth 1 pour les pages seules, ou 2 pour les frames de premier niveau de chaque page, puis lisez un frame avec Obtenir des nœuds du fichier. Figma place cet appel dans son niveau de limite de débit le plus bas : les fichiers d'un plan Starter et les utilisateurs avec un siège View ou Collab n'ont que 20 appels par mois.
- Obtenir des nœuds du fichierGETRenvoie les frames ou calques indiqués d'un fichier, chacun avec tout son sous-arbre, dans nodes, plus le nom, la version et la dernière modification du fichier. Un nœud inexistant revient à null. C'est la manière légère de lire un frame d'un gros fichier. Figma place cet appel dans son niveau de limite de débit le plus bas : les fichiers d'un plan Starter et les utilisateurs avec un siège View ou Collab n'ont que 20 appels par mois.
- Générer des imagesGETGénère des images à partir de frames ou calques d'un fichier et renvoie, dans images, une correspondance entre chaque id de nœud et une URL temporaire de l'image, valable 30 jours. Une valeur null signifie que ce nœud n'a pas pu être rendu. Les images de plus de 32 mégapixels sont réduites. Figma place cet appel dans son niveau de limite de débit le plus bas : les fichiers d'un plan Starter et les utilisateurs avec un siège View ou Collab n'ont que 20 appels par mois.
- Lister les versions du fichierGETListe l'historique des versions d'un fichier, de la plus récente à la plus ancienne : id, date de création, auteur, et le libellé et la description des versions nommées. Pour lire des versions plus anciennes, passez comme before la valeur before du lien pagination.next_page ; l'historique se termine quand next_page est absent.
- Lister les commentairesGETListe tous les commentaires d'un fichier, réponses comprises. Chaque commentaire a id, message, auteur, created_at, resolved_at quand il a été résolu, sa position dans client_meta et les réactions. Une réponse porte l'id de son commentaire racine dans parent_id.
- Créer un commentairePOSTPublie un commentaire sur un fichier en tant qu'utilisateur connecté et le renvoie, ou une réponse quand comment_id est envoyé. Sans client_meta, le commentaire n'est pas épinglé à un endroit du canvas. Un commentaire publié ne peut pas être modifié, seulement supprimé avec Supprimer un commentaire.
- Supprimer un commentaireDELETESupprime un commentaire d'un fichier. Figma ne permet qu'à l'auteur de supprimer un commentaire, donc cela fonctionne sur les commentaires faits par l'utilisateur connecté.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
