renderer
Render
Description: Renders a single Dynamic or Static Code.
BeeTagg Credits: ATTENTION: This method will deduct Credits from your Team (ProviderId). Please consult the pricing page for more information.
URL: https://api.beetagg.com/1.0/api/renderer/Render.ashx
HTTP method: GET
Parameters
Name Description Type Optional Default
TokenYour API token.stringfalsen/a
ProviderIdThe id of the Code / Code Series.int64falsen/a
Format The output graphic format. Possible values:
  • Svg (Vector)
  • Pdf (Vector)
  • Eps (Vector)
  • Ps (Vector)
  • Png (Pixel)
  • Jpeg (Pixel)
stringtrueSvg
SizeThe Size of the code in Pixel. Calculate with 90 DPI. Maximum value is 2000int32true200
RangeIdThe Range Id in case of Dynamic Codes and Code Series.stringtruen/a
OffsetThe offset of the Code Series.stringtrue1
ImagePathURL to an image that gets placed in the center of the Code.stringtruen/a
CodeA Dynamic Code defined by its Hex value.stringtruen/a
Hostname Custom Hostname. Used to render your Codes with your own Custom Hostname. stringtruer.beetagg.com
StringCode String Code. Use this to render Static Codes. E.g. http://www.mypage.com/page3.php
  • stringqrcode:#THE-QR-CODE-CONTENT#
  • stringdatamatrix:#THE-DATAMATRIX-CODE-CONTENT#
stringtruen/a
BgColorThe background color of the Code in RGB hex form. E.g. ff0000 for red.stringtrueffffff
FgColorThe foreground color of the Code in RGB hex form. E.g. ff0000 for red.stringtrue000000
ErrorCorrectionLevel The error correction level for QR Codes. Possible values are:
  • L (equals 7%)
  • M (equals 15%)
  • Q (equals 25%)
  • H (equals 30%)
stringtrueL
ForceDownload Force download. If set to true, the browser will offer to download the code. If set to false, the browser will display the code within the browser window. booltruefalse
ImagenamePattern Image name pattern. If you set the ForceDownload to true, you can define ImagenamePattern. It will define the name of the codes' image file that you will download.
Possible placeholders are:
  • %(date) -> The current date. Format: YYYMMMDD (e.g. 2012Feb27)
  • %(extension) -> The extension with leading period.
  • %(rangeid) -> Id of Code or Code Series.
  • %(offset) -> The offet of a Code Series.
E.g. ThisIsMyCode_%(date)%(extension) --> ThisIsMyCode_2012Feb27.pdf
stringtruecode%(extension)
Response Attributes
Name Description Type
CodeThe service will return a byte array with the codes' image data.Array of bytes (byte[])
Security
Permission Description
RangeModifyInProviderUser (Token) needs to have the permission to add or edit Codes for the Team (ProviderId).
Console
You can make a real request by using the following form.
Token
ProviderId
Format
Size
RangeId
Offset
ImagePath
Code
Hostname
StringCode
BgColor
FgColor
ErrorCorrectionLevel
ForceDownload
ImagenamePattern
ResponseFormat
ATTENTION: This method will deduct Credits from your Team (ProviderId). Please consult the pricing page for more information.
©2005-2018 connvision Ltd - Contact - Privacy - hizmet şartları
English