Obtener archivo en Figma, con una API
Devuelve el árbol del documento de un archivo: páginas, frames y capas con sus propiedades e ids, además de los componentes y estilos que usa el archivo. El árbol de un archivo grande es enorme: pasa depth 1 para solo las páginas, o 2 para los frames de nivel superior de cada página, y luego lee un frame con Obtener nodos del archivo. Figma pone esta llamada en el nivel más bajo de límite de tasa: los archivos en un plan Starter y los usuarios con asiento View o Collab tienen solo hasta 20 llamadas al mes.
- Identificador
- figma_get_file
La llamada
POST https://connect.reportei.com/api/tools/figma_get_file/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>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| file_key | string | Sí | Key of the file: the part after /design/, /file/ or /board/ in the URL of the file in Figma. The key of a branch also works. |
| depth | integer | No | How deep to go into the tree, counted from the document: 1 returns the pages, 2 the pages and their top-level frames. Omit it to return every layer. |
| ids | string | No | Comma-separated node ids, like 1:2,1:3, to return only those nodes, their children and the path to them. A node id is the node-id of a Figma link with the hyphen changed to a colon (node-id=1-2 is 1:2), or an id returned by Get file. |
| version | string | No | Id of a version from List file versions, to read the file as it was then. Omit it for the current version. |
| branch_data | boolean | No | Also returns the branches of the file with their keys, which the other tools accept as file_key. The default is false. |
Conexiones posibles
Tu cliente conecta su cuenta de Figma una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/figma, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/figma_get_file. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Figma
- Obtener metadatos del archivoGETDevuelve los metadatos de un archivo sin su contenido: nombre, carpeta, tipo de editor (Figma Design, FigJam, Slides y otros), creador, quién lo cambió por última vez y cuándo, miniatura, el rol del usuario y el acceso por enlace. Mucho más barato que Obtener archivo en los límites de tasa de Figma, así que úsalo primero cuando la pregunta es sobre el archivo y no sobre sus capas.
- Obtener nodos del archivoGETDevuelve los frames o capas indicados de un archivo, cada uno con todo su subárbol, en nodes, además del nombre, versión y último cambio del archivo. Un nodo que no existe vuelve como null. Es la forma ligera de leer un frame de un archivo grande. Figma pone esta llamada en el nivel más bajo de límite de tasa: los archivos en un plan Starter y los usuarios con asiento View o Collab tienen solo hasta 20 llamadas al mes.
- Renderizar imágenesGETRenderiza frames o capas de un archivo como imágenes y devuelve, en images, un mapa de cada id de nodo a una URL temporal de la imagen, válida por 30 días. Un valor null significa que ese nodo no se pudo renderizar. Las imágenes de más de 32 megapíxeles se reducen. Figma pone esta llamada en el nivel más bajo de límite de tasa: los archivos en un plan Starter y los usuarios con asiento View o Collab tienen solo hasta 20 llamadas al mes.
- Listar versiones del archivoGETLista el historial de versiones de un archivo, de la más reciente a la más antigua: id, fecha de creación, autor, y la etiqueta y descripción de las versiones con nombre. Para leer versiones más antiguas, pasa como before el valor before del enlace pagination.next_page; el historial termina cuando falta next_page.
- Listar comentariosGETLista todos los comentarios de un archivo, respuestas incluidas. Cada comentario tiene id, message, autor, created_at, resolved_at cuando se resolvió, su posición en client_meta y las reacciones. Una respuesta trae el id de su comentario raíz en parent_id.
- Crear comentarioPOSTPublica un comentario en un archivo como el usuario conectado y lo devuelve, o una respuesta cuando se envía comment_id. Sin client_meta el comentario no queda fijado en un punto del canvas. Un comentario publicado no se puede editar, solo eliminar con Eliminar comentario.
- Eliminar comentarioDELETEElimina un comentario de un archivo. Figma solo permite que el autor elimine un comentario, así que funciona con los comentarios hechos por el usuario conectado.
- Listar componentes del archivoGETLista los componentes publicados de un archivo de biblioteca: key, nombre, descripción, node_id, miniatura, fechas, autor y el frame y la página que contienen cada uno. Los componentes nunca publicados no aparecen.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
