CodeQR icon

CodeQR

Consume CodeQR API
Join our community

Actions8

Overview

This node integrates with the CodeQR API to generate QR Codes of various types. It supports creating both static and dynamic QR Codes, allowing users to encode different kinds of data such as URLs, contact information (vCard), emails, phone numbers, geolocations, Wi-Fi credentials, and more.

Common scenarios include:

  • Generating QR Codes for marketing campaigns linking to websites or promotions.
  • Creating contact cards (vCards) that can be scanned to save contact details.
  • Encoding Wi-Fi credentials for easy network access.
  • Producing payment QR Codes (e.g., PIX).
  • Sharing location data or initiating phone calls/SMS via QR Codes.

Practical example: A user wants to create a QR Code that links to their business website with customized colors and a logo. They select the "URL" type, set foreground and background colors, enable the logo display, and generate a static QR Code ready for printing on promotional materials.

Properties

Name Meaning
Authentication Method of authentication; currently only "Access Token" is supported.
QR Code Type The type of QR Code to generate. Options include: Crypto, E-Mail, FaceTime, Geo, Phone, PIX, SMS, Text, URL, vCard, Wi-Fi.
Static/Dynamic Whether the QR Code is static (fixed content) or dynamic (content can be edited later).
Additional Fields A collection of optional fields to customize the QR Code:
- Background Color Background color of the QR Code.
- Description Description associated with the QR Code.
- Email JSON object containing email data for email-based QR Codes.
- Expiration Date Expiration date/time after which the QR Code becomes invalid.
- Foreground Color Foreground color of the QR Code.
- Image URL URL of an image associated with the QR Code.
- Phone Phone number stored in the QR Code.
- Public Stats Boolean indicating whether the QR Code's statistics are publicly accessible.
- Show Logo Boolean indicating whether to display a logo inside the QR Code.
- Size Size of the QR Code in pixels (e.g., 300).
- Text Text content stored in the QR Code.
- Title Title associated with the QR Code.
- Track Conversion Boolean indicating whether to enable conversion tracking for the QR Code.
- URL Destination URL encoded in the QR Code.

Output

The node outputs a JSON array where each item represents the generated QR Code data returned from the CodeQR API. This typically includes metadata about the QR Code such as its unique identifier, the encoded content, URLs to the QR Code image, and any related statistics or status information.

If the API provides binary data (e.g., the QR Code image), it would be included accordingly, but based on the provided code and properties, the output focuses on JSON metadata and URLs rather than raw binary.

Dependencies

  • Requires an API key credential for authenticating with the CodeQR API.
  • The node depends on the external CodeQR service to generate QR Codes.
  • Proper configuration of the API key credential within n8n is necessary.
  • Network connectivity to the CodeQR API endpoint is required.

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is not supported, verify that the selected Resource is "QR Code" and Operation is "Create". Other combinations are not implemented.
  • Authentication Failures: Ensure the API key credential is correctly configured and valid.
  • Invalid Input Data: Providing incomplete or incorrect data for the chosen QR Code type (e.g., missing URL for a URL type QR Code) may cause errors. Double-check required fields per QR Code type.
  • API Rate Limits or Connectivity Issues: Network problems or exceeding API usage limits can cause failures. Check network access and API quota.
  • Color Format Issues: Colors should be specified in valid formats (usually hex codes). Invalid color values might cause the API to reject the request.

Links and References

Discussion