2014-03-02

How do I use the QR Code API?

This API creates QR Codes for use by Web and mobile apps.

Please note that you need a premium CliqTags account to be able to use the API.

CliqTags uses the same API internally.

Endpoint

http://cliqtags.com/qrcodeapi.php

Methods

GET or POST

Arguments

  • username: CliqTags user name. Mandatory.
  • password: CliqTags password. Mandatory.
  • data: Text to encode as a QR Code. See below for encoding different types of data. Mandatory.
  • level: Error correction level: L, M, H or Q. Default: M.
  • size: Size of each point. Default: 2 pixels.
  • margin: Margin in points. Default: 2 points.
  • forecolor: Foreground color in hex RGB. Default: “000000” (black).
  • backcolor: Background color in hex RGB. Default: “FFFFFF” (white).
  • format: Format of generated QR Code: PNG, GIF, JPEG, PDF, EPS or SVG. Default: PNG.
  • text: Text to put below QR Code. Only for bit image formats. Default: none.
  • footer: URL to image file to put below QR Code. Only for bit image formats. Default: none.

Data

  • Text: As-is
  • Link: Complete URL including http:// or https://
  • E.mail: mailto:address?subject=message
  • Call: tel:number
  • SMS: smsto:number:message
  • Location: geo:latitude,longitude (in decimal format)

Notes

  • level, forecolor, backcolor and format are case insensitive.
  • All argument values need to be URL encoded

Examples

Basic

http://cliqtags.com/qrcodeapi.php?username=xxx&password=xxx&data=http://cliqtags.com

Complete

http://cliqtags.com/qrcodeapi.php?username=xxx&password=xxx&data=http://cliqtags.com&level=L&size=4&margin=3&forecolor=008000&backcolor=E0E000&format=PNG&text=My+site&footer=http://cliqtags.com/logo.png