La API de GetQR está en beta y solo está disponible para algunos espacios de trabajo. Los detalles pueden cambiar antes del lanzamiento general.
Sube un archivo
1
Registra el archivo
Llama a Registrar la subida de un archivo con el
target, el contentType y el size del archivo. El target determina los tipos de contenido admitidos y el límite de tamaño. Recibes un fileId y una uploadUrl.2
Envía el archivo
Envía el archivo con una solicitud
PUT a uploadUrl. Su Content-Type y su Content-Length deben coincidir exactamente con el contentType y el size que registraste: cualquier otro valor se rechaza. La URL está prefirmada, así que no añadas tu clave de API. Caduca a los 10 minutos.3
Usa el ID del archivo
Pasa
fileId al crear un código QR:- Como
fileIden un código QRpdf,imageovideo. Súbelo con el target correspondiente. - Como
fileIdpara la imagen de perfil de un código QRvcard,social,multilinkoevent. Súbelo con el targetlogo. - Como
logoOptions.fileId, conlogoOptions.typedefinido comouploaded, para un logotipo personalizado. Súbelo con el targetlogo. Consulta Personalización.
Límites
- Tipo MIME simple. Envía un único tipo y subtipo en minúsculas, como
image/png. Se rechazan los parámetros, como;charset=, y las listas. - Sin SVG. No se aceptan tipos basados en XML, como
image/svg+xml. Sube una imagen de mapa de bits, comoimage/pngoimage/jpeg.
Cabeceras
string
requerido
Bearer seguido de tu clave de API. Consulta Autenticación.string
requerido
application/json.Registrar la subida de un archivo
POST /api/v1/files
Registra un archivo y devuelve una URL prefirmada a la que subirlo. Esta llamada no sube el archivo en sí.
string
requerido
Para qué es el archivo:
pdf, image, video o logo. Determina los tipos de contenido admitidos y el límite de tamaño. Consulta Límites.string
requerido
Tipo MIME del archivo, por ejemplo
application/pdf, sin parámetros. La solicitud de subida debe enviar exactamente este Content-Type.integer
requerido
Tamaño exacto del archivo en bytes, un número entero positivo. Se comprueba con el límite del target. La solicitud de subida debe enviar exactamente este
Content-Length.string
Nombre original del archivo, hasta 255 caracteres. Se conserva para mostrarlo en el panel. Se rechaza una ruta con
/ o \.string
ID que se pasa como
fileId o logoOptions.fileId.string
URL prefirmada a la que se envía el archivo con
PUT.integer
Segundos que faltan para que caduque
uploadUrl: 600.string
Método HTTP de la subida:
PUT.Problemas habituales
422 "Content type … is not allowed for target"
422 "Content type … is not allowed for target"
El tipo de contenido no coincide con el target. Por ejemplo,
pdf solo acepta application/pdf. Consulta Límites.422 "must be a single lowercase type/subtype"
422 "must be a single lowercase type/subtype"
Envía el tipo de contenido en minúsculas y sin parámetros:
image/png, no Image/PNG ni image/png; charset=utf-8.422 "File is too large for target"
422 "File is too large for target"
El
size declarado supera el límite del target. Comprime el archivo antes de registrarlo.Falla la subida a uploadUrl
Falla la subida a uploadUrl
La URL caduca 10 minutos después de registrar el archivo, y la solicitud debe enviar exactamente el
Content-Type y el Content-Length registrados. Vuelve a registrar el archivo para obtener una URL nueva.422 "is registered but its content was never uploaded" al crear un código QR
422 "is registered but its content was never uploaded" al crear un código QR
Registraste el archivo, pero el
PUT a uploadUrl no se completó. Sube el archivo y crea después el código QR.422 "was uploaded to …" al crear un código QR
422 "was uploaded to …" al crear un código QR
El archivo se registró con otro target, por ejemplo un archivo
image usado para un código QR pdf. Registra una nueva subida con el target correspondiente.404 "File … was not found" al crear un código QR
404 "File … was not found" al crear un código QR
El
fileId no existe. Tómalo de la respuesta de Registrar la subida de un archivo.