This Utility API lets you dynamically generate QR codes.
This API service lets you generate vCards or WiFi information as QR Codes and can be scanned using a smartphone or other mobile device, providing quick and easy access to information such as product details, promotions, contact information or WiFi details. These can be accessed and scanned offline, allowing for easy access to information even in areas with limited internet connectivity.
generate qr code file
|The name for the QR code file. If no output attribute is provided, the default file name will be
|Yes (If v_card and wifi_info are not provided)
|Any text or url for which you want to generate QR Code.
|Url of the logo you want in QR Code. Accepts
|Background color of the QR Code in Hexadecimal format. Defaults to
|String or Array
|Foreground color of the QR Code in Hexadecimal format. Defaults to
#ffffff (white). Accepts input as String if one/solid color is used or accepts an Array of String with start and end colors, for a gradient.
|Name of the contact.
|Phone numbers of the contact.
|Organization of the contact.
|Job title of the contact.
|Address of the contact.
|Email address of the contact.
|Website url of the contact.
|Url of the photo of the contact.
|Birthday of the contact in 'YYYYMMDD' format.
|Any additional notes you want to save for the contact.
|Name of the wifi.
|Yes (If auth_type is provided)
|Password of the wifi, for password protected wifi.
|Yes (If password is provided)
|Authentication type of the wifi, for password protected wifi.
A successful request returns the QR code image file.
HTTP Response Codes
The method may return one of the following HTTP status codes:
|The request was successful.
|Required authentication information is either missing or not valid for the resource.
|Invalid input - the content is empty
|If any unexpected error occurs while processing the request
All requests to ApyHub services need to be authenticated, currently we support
basic authentication mechanisms.
You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-tokenas the header parameter to pass the token.
- Use the
Authorizationheader to send the basic authentication credentials.
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.