Skip to main content

QR Code Templates

Overview​

This API provides a set of predefined QR code templates, which can be used to customize the appearance of QR codes generated by the application. Each template is defined by the type of QR code, corner type, and corner dot type.

Endpoint​

GET /api/qr-templates​

Retrieve a list of available QR code templates.

Response​

  • Status: 200 OK
  • Content-Type: application/json
  • Body: 
    {
      "templates": {
        "template_name": {
          "type": "string",
          "corner_type": "string",
          "corner_dot_type": "string"
        }
      }
    }

Available Templates​

Below is a list of the available QR code templates and their configurations:

classic​

  • type: square
  • corner_type: square
  • corner_dot_type: square

classic-dot​

  • type: square
  • corner_type: square
  • corner_dot_type: dot

sleek-square​

  • type: square
  • corner_type: dot
  • corner_dot_type: square

sleek-dot​

  • type: square
  • corner_type: dot
  • corner_dot_type: dot

rounded-classic​

  • type: square
  • corner_type: extra-rounded
  • corner_dot_type: square

rounded-modern​

  • type: square
  • corner_type: extra-rounded
  • corner_dot_type: dot

soft-classic​

  • type: rounded
  • corner_type: square
  • corner_dot_type: square

soft-dot​

  • type: rounded
  • corner_type: square
  • corner_dot_type: dot

soft-sleek​

  • type: rounded
  • corner_type: dot
  • corner_dot_type: square

soft-elegant​

  • type: rounded
  • corner_type: dot
  • corner_dot_type: dot

extra-rounded-classic​

  • type: rounded
  • corner_type: extra-rounded
  • corner_dot_type: square

extra-rounded-modern​

  • type: rounded
  • corner_type: extra-rounded
  • corner_dot_type: dot

dotted-classic​

  • type: dots
  • corner_type: square
  • corner_dot_type: square

dotted-modern​

  • type: dots
  • corner_type: square
  • corner_dot_type: dot

dotted-sleek​

  • type: dots
  • corner_type: dot
  • corner_dot_type: square

dotted-elegant​

  • type: dots
  • corner_type: dot
  • corner_dot_type: dot

dotted-rounded-classic​

  • type: dots
  • corner_type: extra-rounded
  • corner_dot_type: square

dotted-rounded-modern​

  • type: dots
  • corner_type: extra-rounded
  • corner_dot_type: dot

Example Usage​

To retrieve the list of QR code templates, send a GET request to the /api/qr-templates endpoint. The response will include a JSON object containing all the templates and their configurations.