Qivo practical guides
How a QR code generation API works
An API lets you generate QR codes automatically from your website, internal tool or script. Follow the journey from content to a finished image.
Your application sends content and settings; Qivo returns a static QR image. The secret key stays on your server.
From a manual editor to an integration
In the editor, a person fills in fields and clicks download. With an API, a program performs these actions, for example generating a product page QR code while preparing a label.
An API call does not make the code dynamic. The image stores the submitted data rather than an intermediate Qivo URL. You can save and use the file without contacting the generator again.
What a request contains
A GET request contains the service address, parameters and a secret key. The contentType parameter selects the data type, format selects PNG or SVG, and shape, border and center control the design. Plain text requires the data field.
Parameter values must be URL-encoded. Use your language’s standard tools to correctly handle spaces, the + in phone numbers and the # in colors. Invalid or missing required fields cause an error response.
Why the key belongs on your server
The key grants access to generation. Visitors can read a key placed in a public page’s JavaScript. Send requests from your server and load the key from an environment variable.
Send the key in the X-API-Key header over HTTPS. The key URL parameter is also supported, but URLs can appear in history and logs. Never put your secret key in the QR image or public examples.
How to handle the response
A successful response contains the image itself, not JSON with a download link. Check the HTTP status before saving. Errors return JSON with an explanation; do not save that as a PNG.
SVG is useful for printed materials, while PNG suits everyday images. Avoid regenerating a code on every visit to an unchanged page: save and reuse the file. Respect request limits and the Retry-After delay.
What to check before publishing
The API validates input but does not decode the finished image. This reduces processing, but your workflow must handle scan testing. Test typical design combinations and the largest data volumes you expect.
Leave a light quiet zone of at least four modules, good contrast and sufficient size. Scan the final printed layout with a phone. The API page contains technical parameters and ready-to-use PHP, JavaScript, Python and cURL examples.
Sources and further reading
Prepared and maintained by Umind. Test these recommendations on your final layout and target devices.