Consultar design no Canva, por uma API
Retorna um design com título, proprietário, miniatura, page_count e as urls de edição e visualização. Essas urls são temporárias e abrem apenas para o usuário conectado.
- Identificador
- canva_get_design
A chamada
POST https://connect.reportei.com/api/tools/canva_get_design/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"designId": "<designId>"
}
}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 |
|---|---|---|---|
| designId | string | Sim | Id of the design, from List designs, List folder items or Create design. |
Conexões possíveis
O seu cliente conecta a conta do Canva 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/canva, 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/canva_get_design. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Canva
- Listar designsGETLista os designs dos projetos do usuário e os compartilhados com ele, com id, title, thumbnail, page_count e as urls de edição e visualização. Quando a resposta traz continuation, envie-o como continuation para ler a próxima página.
- Criar designPOSTCria um design e o retorna com id e as urls de edição e visualização. Envie design_type, asset_id ou ambos. Um design em branco que ninguém edita em 7 dias é apagado definitivamente, sem ir para a lixeira.
- Listar formatos de exportaçãoGETLista os formatos para os quais um design pode ser exportado, que dependem do tipo e das páginas. Um formato com page_numbers vale apenas para essas páginas.
- Criar exportação de designPOSTInicia a exportação de um design como PDF, JPG, PNG, PPTX ou GIF e retorna o job com seu id. Chame Get design export até o status ser success: as urls dos arquivos valem por 24 horas. Cada usuário pode exportar 75 vezes a cada 5 minutos e 500 vezes por dia.
- Criar exportação de design em vídeoPOSTInicia a exportação de um design como vídeo MP4 e retorna o job com seu id. Chame Get design export até o status ser success: as urls dos arquivos valem por 24 horas. Cada usuário pode exportar 75 vezes a cada 5 minutos e 500 vezes por dia.
- Consultar exportação de designGETRetorna um job de exportação: status in_progress, success ou failed e, com success, as urls dos arquivos, uma por página conforme o formato, válidas por 24 horas. Chame de novo, com esperas crescentes, enquanto o status for in_progress.
- Listar itens da pastaGETLista as pastas, os designs e as imagens de uma pasta, cada um com seu tipo, o objeto de pasta, design ou imagem e seu id. Vídeos não são listados. Quando a resposta traz continuation, envie-o como continuation para ler a próxima página.
- Consultar assetGETRetorna um asset com nome, tags, miniatura, proprietário e datas.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
