Generador de códigos QR

1. Introducción

Este servicio facilita la creación de imágenes de códigos QR. Se puede utilizar para renderizar una URL que queramos codificar o un QR dinámico para generar un cobro.

2. Uso

2.1. Renderizar un código QR

Método: GET

URL: {endpoint}/api/v2/qr/render

Campo	Requerido	Opciones	Valor por defecto	Tipo
content	Si		null	URL
output	No	svg, png, base64	svg	String
lang	No	en,es	null	String

• content: Debe ser una URL válida y estar codificada con URLEncoded.
• output: Si se envía el parámetro output como base64 se obtendrá una respuesta en formato JSON por parte del servidor, de lo contrario se obtendrá la imagen en formato svg opng según se haya elegido.
• lang: Si se envía el parámetro lang se agregara un marco a la imagen y debajo de la imagen QR aparecerá la palabra SCAN ME si se envía en o ESCANÉAME si se envía es.

Ejemplo:

https://{endpoint}/api/v2/qr/render?content=https://google.com&lang=es&output=base64

Respuesta de una petición en base64

{
    "success": true,
    "message": "Información obtenida con éxito",
    "data": {
        "url": "https://google.com",
        "base64": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvb..."
    }
}

Campos de la respuesta 

Campo	Tipo	Descripción
success	Boolean	Este campo es verdadero cuando la transacción resultó exitosa
message	String	Mensaje con la confirmación de éxito
data	Object	Contenedor de la información del Código QR
url	String	URL codificada
base64	String	Imagen en base64

2.2. Código QR dinámico

Método: GET 

URL: {endpoint}/api/v2/qr/generate

2.2.1. Uso de las llaves

Para poder generar imágenes de QR dinámicos es necesario contar con las llaves del comercio que se utilizaran en los headers de la petición, junto con él Accept: Application/json es importante que la Secret Key no se comparta como se muestra en la aplicación, ya que puede quedar expuesta. La llave se debe preparar con MD5 para poder ser utilizada.

Generador de MD5 HASH online https://www.md5hashgenerator.com/

Headers

Accept: application/json  
x-auth-key: 12345678  
x-auth-hash: 8e68546db84c4aa7988085b6e0fa944c // MD5 del secret Key

Parámetros

Campo	Requerido	Validaciones	Tipo
amount	Si		Float
tax_amount	No		Float
order_id	No	Máximo 50 caracteres	String
order_description	No	Máximo 120 caracteres	String
order_reference	No	Máximo 120 caracteres	String

• amount: Cantidad a cobrar.
• tax_amount: Valor del impuesto.
• order_id: Número de orden. Si no es enviado el order_id es autogenerado por la plataforma de Pixel.
• order_description: Descripción de la orden. Si no es enviado el order_description es autogenerado por la plataforma de PixelPay.
• order_reference: Referencia de la compra (útil para el comercio). Este valor es retornado en el campo extras del Webhook.

2.2.2.  Configuración del Webhook

Dentro de la plataforma de PixelPay debemos entrar a Preferencias > Opciones de API Y activamos el switch de Activar Webhook y colocamos la URL a la que se realizará la petición en el campo URL de Éxito.

Imagen 1: Activar Webhook.

Ejemplo:

https://{endpoint}/api/v2/qr/generate?tax_amount=10&order_
id=1001&order_description=Pago generado con QR&order_reference=
Cobro de prueba&amount=155

Respuesta:

@return {
    "success": true,
    "message": "Información obtenida con éxito",
    "data": {
        "url":  'https://endpoint.app/company/qr/a8Zux99kmGuylmmSl+KyxJzSUJfJocmpkZrRWMfV0oOJtbKn0pOlolbJnoLW2NfIl8SsYQ==',  
        "base64":  'data:image/svg+xml;base64,...'
    }
}