WhatsApp

Referência da API

Use a API HTTP da Vecsy para transformar um template em um arquivo PNG ou PDF. Cada requisição bem-sucedida devolve uma URL temporária de download.

Visão geral

  • URL base: https://www.vecsy.co
  • O endpoint público fica em /api/.
  • Toda chamada à API precisa de um token bearer válido (veja abaixo).

Autenticação

Envie seu token no cabeçalho Authorization. As duas formas abaixo são aceitas:

Authorization: Bearer YOUR_TOKEN_HERE
Authorization: YOUR_TOKEN_HERE

Crie e gerencie tokens na sua conta da Vecsy: abra Automação e depois a seção API (com login feito). Guarde os tokens em segurança, como se fossem senhas.

Gerar imagem

POST /api/generate-image

Gera um arquivo a partir de um template da sua conta que esteja no estado Pronto. Envie todos os campos dinâmicos definidos nesse template.

Parâmetros obrigatórios e opcionais

Nome Descrição
template_uuid UUID do template (Pronto).
file_format Opcional. Use png (padrão) ou pdf.
… Um valor por campo dinâmico do template (os nomes são os que você configurou no editor).

Exemplo (JSON)

curl -X POST "https://www.vecsy.co/api/generate-image" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -d '{
    "template_uuid": "18cc03b9-68c9-4aaf-ad74-17c8c76e0827",
    "file_format": "png",
    "title": "Example headline",
    "photo": "https://example.com/image.jpg"
  }'

Troque os nomes e valores dos campos pelos do seu template.

Formatos de requisição

JSON — Content-Type: application/json. Campos de imagem precisam ser URLs HTTPS públicas. O modo JSON não aceita upload de arquivo.

Multipart form-data — Use quando precisar enviar o arquivo da imagem. Os campos que não são arquivo vão no formulário; a parte do arquivo normalmente se chama file.

Se mais de um campo de imagem for enviado como upload (e não como URL), o upload deve ser um único arquivo .zip com as imagens que o template pede.

Campos do template

  • Textos e outros campos que não são imagem: envie o valor como string no JSON ou como campo do formulário.
  • Campos de imagem: uma URL em string (https://…) no JSON, ou um arquivo enviado no modo multipart.
  • Cores em hexadecimal devem seguir o formato #RRGGBB (seis dígitos hexadecimais).

Respostas e erros

Em caso de sucesso (HTTP 200), a resposta traz uma URL temporária do arquivo, a chave de armazenamento e o formato de saída. Baixe o arquivo logo: o link pode expirar.

{
  "url": "https://…",
  "key": "uploads/api/generate-image/…",
  "format": "png"
}

As respostas de erro mais comuns vêm em JSON com uma mensagem de erro, por exemplo:

  • 401 — Token ausente ou inválido.
  • 400 — Erro de validação, campo faltando, cor inválida, tipo de upload errado ou limite de requisições da API atingido.
  • 404 — Template não encontrado ou fora do estado Pronto.

Limites

O uso da API conta na cota de requisições do seu plano da Vecsy. Se a cota acabar, a API devolve erro até o limite renovar ou o plano mudar.

Ver planos Voltar para a página da API