Listar componentes do time no Figma, por uma API
Lista 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.
- Identificador
- figma_list_team_components
A chamada
POST https://connect.reportei.com/api/tools/figma_list_team_components/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"team_id": "<team_id>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| team_id | string | Sim | Id of the team: the number after /team/ in the URL of the team page in Figma. The API has no call that lists teams. |
| page_size | integer | Não | Components per page, up to 1000. The default is 30. |
| after | integer | Não | The meta.cursor.after value of the previous response, to read the next page. |
Conexões possíveis
O seu cliente conecta a conta do Figma uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
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.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/figma_list_team_components. Ele vira a definição de tool do seu agente sem conversão.
Outras 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
