Tools de Figma
Las 12 operaciones de Figma que tu producto ejecuta en la cuenta de tu cliente con Connect. Todas usan el mismo endpoint, POST /api/tools/{tool}/execute.
- 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 archivoGETDevuelve 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.
- 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.
- Listar componentes del equipoGETLista los componentes publicados en las bibliotecas de un equipo, con el file_key y el node_id de cada uno, que Obtener nodos del archivo y Renderizar imágenes aceptan. La respuesta trae meta.cursor: pasa su valor after como after para leer la página siguiente; la lista termina cuando falta after.
- Listar estilos del archivoGETLista los estilos publicados de un archivo de biblioteca: colores, texto, efectos y cuadrículas, con key, nombre, style_type, descripción y node_id. Los valores de un estilo están en su nodo: léelos con Obtener nodos del archivo.
- Listar estilos del equipoGETLista los estilos publicados en las bibliotecas de un equipo, con el file_key y el node_id de cada uno; los valores están en el nodo, léelos con Obtener nodos del archivo. La respuesta trae meta.cursor: pasa su valor after como after para leer la página siguiente; la lista termina cuando falta after.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
