QR Code v1
Information to call the QR Code v1 template
- API End Point:
- https://api.advicement.io/v1/templates/pub-qr-code-v1/compile
- Authentication:
- Use your API Security Token (which is generated in your dashboard) in the Adv-Security-Token header parameter
Refer to our authentication guide for more information.
- Uses Luatex:
- FALSE
- Uses Charts:
- FALSE
- Available On:
documentSettings - A JSON object which contains the settings of the template (pageHEXColour, qrCodeHEXColour, textHEXColour, font, qrCodeHeight, documentHeight, documentWidth).
pageHEXColour - An optional string which contains the page colour of the document in HEX. The default value is 'FFFFFF'.
qrCodeHEXColour - An optional string which contains the colour of the QR code in HEX. The default value is '000000'.
textHEXColour - An optional string which the colour of the text in HEX. The default value is '222222'.
font - An optional string which contains the font of the document. Possible options are: 'helvetica', 'avant garde', 'sans serif', 'charter', 'open sans', 'bera', 'venturis', 'raleway', 'overlock', 'roboto', 'spectral', 'clear sans', 'noto sans', 'noto mono', 'josefin', 'bera sans', 'latin modern', 'theano modern', 'droid sans', 'fira sans', 'XCharter', 'bookman', 'gyre bonum', 'gyre schola', 'gyre termes'.
qrCodeHeight - An optional string relating to the height of the QR code (in cm). The default value is '8cm'.
documentHeight - An optional string relating to the height of the document (in cm). The default value is '10cm'.
documentWidth - An optional string relating to the width of the document (in cm). The default value is '10cm'.
documentContent - A JSON object which contains the content of the template (caption, url).
caption - An optional string which contains the text of the caption. It is also allowed to contain LaTeX commands (e.g. '\Large SCAN me')
url - An optional string which contains the url for the QR code. If this field is missing, the QR code will not be created.