Skip to content
This repository has been archived by the owner on Sep 22, 2024. It is now read-only.

QR Code API

1dot75cm edited this page Oct 4, 2016 · 1 revision

What is a QR Code?

A Quick Response code is a two-dimensional pictographic code used for its fast readability and comparatively large storage capacity. The code consists of black modules arranged in a square pattern on a white background. The information encoded can be made up of any kind of data (e.g., binary, alphanumeric, or Kanji symbols)

API Usage

It's very similar python-qrcode's usage. Please see following example.

parameter

name description example
url encode data url=I love Fedora.
version qrcode size (1-40, 1=21x21 matrix, default auto) version=4
correct error correction (`[L* M
box_size box size in qrcode (default 10px) box_size=6
border border size (default 1) border=2
fcolor front color (default black) fcolor=green or RGB
bcolor back color (default white) fcolor=red or RGB
factor a fraction (default 4) factor=5 # 1/5
icon small image (default fedora) icon=http://www.xxx.org/icon.png
box small image position (default center) box=left,top

example

The QR Code box size 6px, border 2, error correction Q, background color ffc, front color 658, icon is https://avatars0.githubusercontent.com/u/8544397, fraction is 5, left 138px and top 56px.