Produtividade
Figma no seu produto e nos seus agentes de IA, por uma API
O toolkit do Figma cobre metadados e conteúdo de arquivos, renderização de nós, histórico de versões, comentários e os componentes e estilos publicados em bibliotecas. Seu cliente conecta o Figma uma vez por OAuth, e seu produto ou agente de IA chama cada operação pelo Connect, que guarda e renova as credenciais e registra cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/figma_create_comment/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>",
"message": "<message>"
}
}Como funciona
Do cliente conectado à primeira chamada no Figma.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do Figma. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o Figma.
Revisão de design no seu app
Liste os comentários de um arquivo e publique respostas ou novos comentários como o usuário conectado, deixando o feedback de revisão junto do seu fluxo.
Exporte frames como imagem
Leia um frame com Obter nós do arquivo e chame Renderizar imagens para obter URLs temporárias de imagem para handoff, documentação ou prévias.
Agente lê o design system
Um agente de IA lista os componentes e estilos publicados de um time e lê seus nós para responder perguntas sobre o design system.
Tools
12 tools do Figma
- Obter metadados do arquivoGETRetorna os metadados de um arquivo sem o conteúdo: nome, pasta, tipo de editor (Figma Design, FigJam, Slides e outros), criador, quem alterou por último e quando, miniatura, o papel do usuário e o acesso por link. Bem mais barato que Obter arquivo nos limites de taxa do Figma, então use primeiro quando a pergunta é sobre o arquivo e não sobre suas camadas.
- Obter arquivoGETRetorna a árvore do documento de um arquivo: páginas, frames e camadas com suas propriedades e ids, além dos componentes e estilos que o arquivo usa. A árvore de um arquivo grande é enorme: passe depth 1 para só as páginas, ou 2 para os frames de nível superior de cada página, e depois leia um frame com Obter nós do arquivo. O Figma coloca esta chamada no menor nível de limite de taxa: arquivos em um plano Starter e usuários com assento View ou Collab têm só até 20 chamadas por mês.
- Obter nós do arquivoGETRetorna os frames ou camadas indicados de um arquivo, cada um com toda a sua subárvore, em nodes, além do nome, versão e última alteração do arquivo. Um nó que não existe volta como null. É a forma leve de ler um frame de um arquivo grande. O Figma coloca esta chamada no menor nível de limite de taxa: arquivos em um plano Starter e usuários com assento View ou Collab têm só até 20 chamadas por mês.
- Renderizar imagensGETRenderiza frames ou camadas de um arquivo como imagens e retorna, em images, um mapa de cada id de nó para uma URL temporária da imagem, válida por 30 dias. Valor null significa que aquele nó não pôde ser renderizado. Imagens acima de 32 megapixels são reduzidas. O Figma coloca esta chamada no menor nível de limite de taxa: arquivos em um plano Starter e usuários com assento View ou Collab têm só até 20 chamadas por mês.
- Listar versões do arquivoGETLista o histórico de versões de um arquivo, da mais recente à mais antiga: id, data de criação, autor, e o rótulo e a descrição das versões nomeadas. Para ler versões mais antigas, passe como before o valor before do link pagination.next_page; o histórico termina quando next_page não existe.
- Listar comentáriosGETLista todos os comentários de um arquivo, respostas incluídas. Cada comentário tem id, message, autor, created_at, resolved_at quando foi resolvido, sua posição em client_meta e as reações. Uma resposta traz o id do comentário raiz em parent_id.
- Criar comentárioPOSTPublica um comentário em um arquivo como o usuário conectado e o retorna, ou uma resposta quando comment_id é enviado. Sem client_meta o comentário não fica fixado em um ponto do canvas. Um comentário publicado não pode ser editado, só excluído com Excluir comentário.
- Excluir comentárioDELETEExclui um comentário de um arquivo. O Figma só permite que o autor exclua um comentário, então funciona nos comentários feitos pelo usuário conectado.
- Listar componentes do arquivoGETLista os componentes publicados de um arquivo de biblioteca: key, nome, descrição, node_id, miniatura, datas, autor e o frame e a página que contêm cada um. Componentes nunca publicados não aparecem.
- Listar componentes do timeGETLista os componentes publicados nas bibliotecas de um time, com o file_key e o node_id de cada um, que Obter nós do arquivo e Renderizar imagens aceitam. A resposta traz meta.cursor: passe seu valor after como after para ler a próxima página; a lista termina quando after não existe.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/figma, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
Perguntas sobre o toolkit do Figma
Preciso implementar a API do Figma?
Não. O Connect já traz 12 tools do Figma descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do Figma?
Pelo modo que o toolkit aceita: OAuth com o app do seu produto. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
