Introducción

Bienvenido a la documentación de la API de Dynamic Canvas. Nuestra API REST te permite generar imágenes dinámicamente mediante programación, perfecto para automatizar tu flujo de trabajo de diseño a escala.

Inicio Rápido

Comienza con Dynamic Canvas en tres simples pasos.

curl -X POST https://api.dynamiccanvas.com/v1/render \
  -H "Authorization: Bearer $DYNAMIC_CANVAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "social-media-post",
    "modifications": [
      { "name": "title", "text": "Hello World" },
      { "name": "image", "src": "https://example.com/image.jpg" }
    ],
    "format": "png"
  }'

{
  "success": true,
  "render_id": "render_abc123",
  "url": "https://cdn.dynamiccanvas.com/renders/abc123.png",
  "width": 1080,
  "height": 1080,
  "format": "png",
  "created_at": "2025-01-15T10:30:00Z"
}

Autenticación

Todas las solicitudes API requieren autenticación usando Bearer tokens. Incluye tu API key en el header Authorization de cada solicitud.

Descripción General de la API

La API de Dynamic Canvas está organizada alrededor de REST. Nuestra API usa códigos de respuesta HTTP estándar, autenticación y verbos.

Endpoints Disponibles

Endpoint de Render

El endpoint de render es el núcleo de nuestra API. Envía una solicitud POST con tu ID de plantilla y modificaciones para generar una nueva imagen.

{
  "template_id": "string (required)",
  "modifications": [
    {
      "name": "string (required) - element name in template",
      "text": "string (optional) - for text elements",
      "src": "string (optional) - for image elements",
      "value": "string (optional) - for color/style elements",
      "visible": "boolean (optional) - show/hide element"
    }
  ],
  "format": "string (optional) - png, jpg, webp, pdf. Default: png",
  "width": "number (optional) - override template width",
  "height": "number (optional) - override template height",
  "scale": "number (optional) - 1x, 2x, 3x. Default: 1x"
}

Ejemplo de Solicitud

{
  "template_id": "instagram-post",
  "modifications": [
    {
      "name": "headline",
      "text": "Summer Sale 50% OFF"
    },
    {
      "name": "product_image",
      "src": "https://example.com/product.jpg"
    },
    {
      "name": "price",
      "text": "$29.99"
    },
    {
      "name": "accent_color",
      "value": "#ff6b6b"
    },
    {
      "name": "disclaimer",
      "visible": false
    }
  ],
  "format": "png",
  "scale": 2
}

Respuesta

{
  "success": true,
  "render_id": "render_xyz789",
  "url": "https://cdn.dynamiccanvas.com/renders/xyz789.png",
  "width": 1080,
  "height": 1080,
  "format": "png",
  "file_size": 245678,
  "created_at": "2025-01-15T14:22:30Z",
  "expires_at": "2025-01-22T14:22:30Z"
}

Plantillas

Las plantillas son la base de tus imágenes dinámicas. Usa el endpoint de plantillas para listar e inspeccionar las plantillas disponibles.

{
  "templates": [
    {
      "id": "instagram-post",
      "name": "Instagram Post",
      "width": 1080,
      "height": 1080,
      "elements": ["headline", "product_image", "price", "cta"],
      "thumbnail": "https://cdn.dynamiccanvas.com/templates/instagram-post.png"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Modificaciones

Las modificaciones te permiten personalizar los elementos de la plantilla. Cada modificación apunta a un elemento específico por nombre y aplica el cambio deseado.

Formatos de Salida

Dynamic Canvas soporta múltiples formatos de salida para satisfacer tus necesidades.

Manejo de Errores

La API usa códigos de respuesta HTTP convencionales para indicar el éxito o fracaso de una solicitud.

Crear Plantillas

Crea plantillas usando nuestro editor visual en el dashboard. Las plantillas definen el diseño base que será modificado vía API.

Imágenes Dinámicas

Reemplaza imágenes en tus plantillas dinámicamente. Las imágenes se obtienen de URLs que proporcionas.

Texto Dinámico

Modifica elementos de texto en tus plantillas con contenido dinámico.

Procesamiento por Lotes

Genera múltiples imágenes eficientemente iterando a través de tus datos.

# Example: Generate multiple social posts
templates = [
  { "title": "Product A", "image": "product-a.jpg" },
  { "title": "Product B", "image": "product-b.jpg" },
  { "title": "Product C", "image": "product-c.jpg" },
]

for item in templates:
  response = requests.post(
    "https://api.dynamiccanvas.com/v1/render",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
      "template_id": "instagram-post",
      "modifications": [
        { "name": "headline", "text": item["title"] },
        { "name": "product_image", "src": item["image"] }
      ]
    }
  )
  print(response.json()["url"])

n8n

Conecta Dynamic Canvas a flujos de trabajo de n8n para automatización poderosa. Usa el nodo HTTP Request para llamar nuestra API.

Zapier

Integra Dynamic Canvas con más de 5000 apps usando Zapier. Crea Zaps que generen imágenes basadas en triggers de otras apps.

Make (Integromat)

Usa Make (antes Integromat) para crear escenarios de automatización complejos con Dynamic Canvas.

SDKs y Librerías

Usa nuestros SDKs oficiales para una integración más rápida en tu lenguaje preferido.

Límites de Tasa

Los límites de tasa varían por plan. Exceder los límites resultará en errores 429.

Precios

Dynamic Canvas ofrece precios flexibles para adaptarse a tus necesidades.