Introducción a la API

​

Qué puedes hacer

​

Guías

​

URL base

https://getqr.com/api/v1

​

Versiones

• Los cambios incompatibles se publican con un nuevo prefijo de versión, como /api/v2/, y /api/v1/ sigue funcionando.
• Los cambios compatibles, como campos opcionales o endpoints nuevos, pueden aparecer dentro de v1. Ignora los campos de respuesta que tu código no reconozca.

​

Inicio rápido

curl https://getqr.com/api/v1/health

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-qr-0001" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page"
  }'

curl "https://getqr.com/api/v1/qrs/{qrId}/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

​

Solicitudes y respuestas

• Formato. Envía el cuerpo de las solicitudes como JSON con Content-Type: application/json. La excepción es la subida de CSV de la creación masiva, que usa multipart/form-data.
• Respuestas. Las respuestas son JSON. Las descargas, como las imágenes de QR y los archivos ZIP de la creación masiva, devuelven el propio archivo.
• Fechas. Las fechas son cadenas ISO 8601 en UTC, por ejemplo 2026-08-01T10:00:00.000Z.
• Parámetros de consulta. Los parámetros booleanos aceptan las cadenas true o false.
• Actualizaciones parciales. Los endpoints PATCH solo cambian los campos que envías.
• Secretos. Las respuestas nunca incluyen contraseñas ni identificadores internos. Un código QR protegido con contraseña solo indica passwordProtected: true.
• Espacio de trabajo. Cada solicitud se ejecuta en el espacio de trabajo al que pertenece tu clave de API. No indicas ningún ID de espacio de trabajo. Consulta Acceso y roles.
• Errores. Las solicitudes fallidas devuelven un objeto error con un code estable. Consulta Errores.

​

Paginación

{
  "data": [ … ],
  "pagination": { "page": 1, "pageSize": 50, "total": 128, "hasMore": true }
}

​

Idempotencia

-H "Idempotency-Key: order-4821-qr"

• Si repites la solicitud con la misma clave en un plazo de 24 horas, obtienes la respuesta original en lugar de un segundo código QR.
• La cabecera de respuesta x-idempotent-replay es true en una respuesta repetida y false en una nueva.
• Si la primera solicitud con esa clave sigue en curso, la API responde 409 conflict. Reintenta cuando termine.
• Si reutilizas una clave con otro cuerpo de solicitud, la respuesta es 422 unprocessable_entity.
• Sin la cabecera, un cuerpo de solicitud idéntico enviado en menos de 30 segundos se trata como duplicado.

​

Límites de tasa

​

Próximamente

​

Siguientes pasos