Una API QR para gestionar recursos de campaña

DOCIntroducción

Construye tu flujo con los códigos QR, enlaces cortos, páginas, formularios y enlaces GS1 del espacio de trabajo. La API aplica las mismas verificaciones de propiedad, validación de entradas y cuotas que el centro de usuario. Empieza con un recurso de prueba antes de automatizar un lote.

URL base

https://qrcodetransfer.com/api/v1/

Los datos son privados. Cada solicitud verifica el espacio y los permisos del usuario o clave API.

AUTHAutenticación

Crea una clave si tu plan incluye API. Guárdala en el servidor. Cada clave pertenece a un espacio y tiene permisos de lectura o escritura.

Authorization: Bearer YOUR_API_KEY

QRCódigos QR

Los códigos dinámicos mantienen la dirección impresa al actualizar el destino. Los estáticos contienen directamente los datos y no permiten cambiar el destino.

POST /api/v1/workspaces/WORKSPACE_ID/assets

{
  "kind": "QRCODE",
  "name": "Spring campaign",
  "payload": {
    "type": "LINK",
    "url": "https://example.com/campaign",
    "dynamic": true
  }
}

PDFCódigos para PDF

Sube el PDF y crea el código con su identificador. La versión anterior sigue disponible hasta actualizar el recurso. Los archivos sin publicar requieren autenticación.

POST /api/v1/workspaces/WORKSPACE_ID/files
Content-Type: multipart/form-data

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "QRCODE", "name": "Product guide",
  "payload": { "type": "PDF", "fileId": 123, "dynamic": true } }

LINKEnlaces cortos

Crea un enlace de tipo SHORTLINK hacia HTTP o HTTPS. La ruta personalizada es opcional y se conserva reservada incluso al enviar el enlace a la papelera.

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "SHORTLINK", "name": "Product launch",
  "payload": { "url": "https://example.com/launch" } }

PAGEPáginas de destino

Las páginas empiezan como borradores. Añade título y enlaces y publica. Editar el borrador no cambia la versión pública hasta volver a publicar.

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "PAGE", "name": "Our links", "payload": {
  "title": "Our links",
  "links": [{ "label": "Website", "url": "https://example.com" }]
} }

POST /api/v1/workspaces/WORKSPACE_ID/assets/ASSET_ID/actions/publish

FORMFormularios

Cada respuesta conserva la definición publicada de campos. Usa sus identificadores. Una clave de idempotencia devuelve el resultado original al repetir. Cerrar mantiene la página y detiene nuevas respuestas.

POST /api/public/forms/FORM_SLUG/submissions
{ "answers": { "email": "[email protected]" },
  "idempotencyKey": "submission-unique-id" }

GS1GS1 Digital Link

Los códigos incluyen un identificador de aplicación en su URI. Valídalo antes de imprimir. La identidad del producto no cambia al modificar el destino. Prueba el código en tu proceso comercial y de empaquetado.

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "GS1", "name": "Product", "payload": {
  "identifierType": "01", "identifierValue": "09506000134369",
  "destinationUrl": "https://example.com/product"
} }

BULKGeneración masiva

Previsualiza cada fila. Se muestran URLs inválidas y rutas reservadas. Reutiliza la misma Idempotency-Key al reintentar para evitar duplicados.

POST /api/v1/workspaces/WORKSPACE_ID/bulk/preview
POST /api/v1/workspaces/WORKSPACE_ID/bulk/execute
Idempotency-Key: unique-batch-id

{ "kind": "SHORTLINK", "rows": [
  { "name": "Launch", "url": "https://example.com/launch" }
] }

HOOKWebhooks

Los propietarios gestionan webhooks si el plan lo permite. El envío debe activarse y configurarse. Los registros muestran el resultado real; guardar un endpoint no significa que se haya enviado una notificación.

HTTPErrores y estados

Los errores incluyen código, mensaje y campos. 401: autenticación; 403: acceso denegado; 409: conflicto de estado, versión, ruta, cuota o idempotencia; 422: datos inválidos; 503: servicio no disponible. Los códigos pausados o bloqueados devuelven 410.

MCPIntegración MCP

Conecta un cliente HTTP MCP con tu clave. Este endpoint sin estado ofrece JSON y cinco herramientas: listar, consultar, crear, actualizar y analizar. Escribir requiere su permiso. La compatibilidad y el inicio directo siguen en revisión.

POST /api/mcp
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{ "jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {} }