La API de GetQR está en beta y solo está disponible para algunos espacios de trabajo. Los detalles pueden cambiar antes del lanzamiento general.
styles, frameOptions y logoOptions. Nunca incluye contenido ni un enlace. Las plantillas se comparten con todo el espacio de trabajo.
Aplicar una plantilla
PasatemplateId al crear un código QR. El diseño de la plantilla se aplica al nuevo código QR. Los objetos de diseño que envíes en la misma solicitud se combinan sobre él.
- Copiado, no vinculado. El código QR guarda su propia copia del diseño. Editar o eliminar la plantilla más tarde no lo cambia.
- Solo diseños personalizados. Una plantilla con
designKindbrandedoaino se puede aplicar con la API y devuelve422(art_template_unsupported). - Solo tu espacio de trabajo. Una plantilla desconocida, o de otro espacio de trabajo, devuelve
404.
Cabeceras
string
requerido
Bearer seguido de tu clave de API. Consulta Autenticación.string
application/json. Obligatorio en las solicitudes con cuerpo.El objeto de plantilla
string
ID de la plantilla, por ejemplo
qrt_8Hs2mQvKpLd4RtYw.string
Nombre que se muestra al elegir una plantilla.
string
Solo lectura.
custom es un diseño que la API puede editar por completo. branded y ai son un Branded design o un AI design creado en el panel: su imagen no se puede editar con la API y se conserva cuando cambias los demás campos de diseño.object
El diseño guardado. Cada campo tiene la misma forma que el campo de la solicitud con el mismo nombre, así que puedes volver a enviarlo.
string
Fecha de creación, ISO 8601.
string
Fecha de la última actualización, ISO 8601.
Listar plantillas
GET /api/v1/templates
Devuelve las plantillas de tu espacio de trabajo, de la más reciente a la más antigua. La lista está paginada: consulta Paginación.
integer
predeterminado:"1"
Página que se devuelve, 1 o más.
integer
predeterminado:"100"
Resultados por página, de 1 a 100.
Crear una plantilla
POST /api/v1/templates
Guarda un diseño nuevo. Responde 201 Created. Los campos de diseño se validan con los catálogos de Personalización, así que una forma, un marco o un logotipo desconocido se rechaza con 422.
string
requerido
Nombre que se muestra al elegir una plantilla, de 1 a 40 caracteres.
object
Formas y colores de los puntos y las esquinas. Consulta Personalización.
object
Marco dibujado alrededor del código QR y su texto de llamada a la acción. Consulta Personalización.
object
Logotipo colocado en el centro: un logotipo sugerido o tu propio archivo subido con el target
logo de Archivos. Consulta Personalización.Obtener una plantilla
GET /api/v1/templates/{templateId}
string
requerido
ID de la plantilla. Tómalo de la respuesta del listado o de la creación.
Actualizar una plantilla
PATCH /api/v1/templates/{templateId}
Envía solo los campos que quieras cambiar. Los objetos de diseño se combinan con el diseño guardado, así que un styles parcial conserva el resto. Los códigos QR ya creados a partir de la plantilla conservan el diseño con el que se crearon.
string
requerido
ID de la plantilla.
string
Nombre nuevo, de 1 a 40 caracteres.
object
Cambios de estilo, que se combinan con el
styles guardado.object
Cambios del marco, que se combinan con el marco guardado.
object
Cambios del logotipo, que se combinan con el logotipo guardado.
Eliminar una plantilla
DELETE /api/v1/templates/{templateId}
Elimina la plantilla. Los códigos QR creados a partir de ella conservan su diseño.
string
requerido
ID de la plantilla.
Duplicar una plantilla
POST /api/v1/templates/{templateId}/duplicate
Crea una copia llamada <name> copy, con su propio ID y un diseño independiente que puedes editar libremente. No lleva cuerpo de solicitud. Responde 201 Created.
string
requerido
ID de la plantilla que se copia.
Problemas habituales
404 "QR template not found."
404 "QR template not found."
El
templateId no coincide con ninguna plantilla de tu espacio de trabajo. Tómalo de Listar plantillas.422 al crear o actualizar una plantilla
422 al crear o actualizar una plantilla
Un campo de diseño no coincide con los catálogos, por ejemplo un tipo de punto, un marco o un logotipo sugerido desconocido. El mensaje indica el campo. Consulta Personalización.
422 art_template_unsupported al crear un código QR
422 art_template_unsupported al crear un código QR
La plantilla usa un Branded design o un AI design. Aplica en su lugar una plantilla con
designKind custom.