Фриланс-проекты

Фриланс-проекты

Написание API для генерации QR

Веб-программирование — неверно указаны категории?

8800 UAH

Проект переведен автоматически. Войдите или зарегистрируйтесь, чтобы увидеть оригинал

Написание API для генерации QR

За основу можно взять готовые библиотеки с GitHub:
x-hw/amazing-qr: 💮 amazing QRCode generator in Python (supporting animated gif) - Python amazing 二维码生成器（支持 gif 动态图片二维码）
soldair/node-qrcode: qr code generator
latentcat/qrbtf: AI & parametric QR code generator. AI & 参数化二维码生成器。https://qrbtf.com
chillerlan/php-qrcode: A PHP QR Code generator and reader with a user-friendly API.

Documentation

Create Custom QR Code

URL	/qr/custom
Methods	GET, POST, OPTIONS
Response	Binary Image File (PNG, SVG, PDF, EPS)

Create any custom QR code with this API. You can access this endpoint with POST and GET.

POST Request

All Parameters need to be send as JSON object in the request body.

GET Request

All Parameters need to be added in the URL. Parameters and the JSON config object needs to be URL encoded.

Parameters

Parameter	Type	Default	Description
data	String	required	The content you want to put in your QR Code (e.g. URL). URL encode the string for GET Requests.
size	Number	300	The minimum pixel size of your QR code image. Actual size of the QR code can be slightly bigger depending on data and configuration.
config	JSON Object	{ }	The config JSON object defines the look of your QR code. Set colors, logo and design. URL encode the JSON string for GET Requests. See the documentation for the config JSON object
file	String	png	The output file format for your QR code. There are different formats available: "png", "svg" (support all config options), "pdf", "eps" (no support for color gradients).
download	Boolean	false	Set to true to force direct download of image file in Browser. Useful in GET scenarios.

Config JSON Object

With the 'config' object you can customize the look and feel of your QR code. It is a JSON object with different parameters to set colors, logo and design.

Parameter	Type	Default	Description
body	String	square	square mosaic dot circle circle-zebra circle-zebra-vertical circular edge-cut edge-cut-smooth japnese leaf pointed pointed-edge-cut pointed-in pointed-in-smooth pointed-smooth round rounded-in rounded-in-smooth rounded-pointed star diamond
eye	String	frame0	frame0 frame1 frame2 frame3 frame4 frame5 frame6 frame7 frame8 frame10 frame11 frame12 frame13 frame14 frame16
eyeBall	String	ball0	ball0 ball1 ball2 ball3 ball5 ball6 ball7 ball8 ball10 ball11 ball12 ball13 ball14 ball15 ball16 ball17 ball18 ball19
erf1	Array	[ ]	Rotate the upper left eye element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.
erf2	Array	[ ]	Rotate the upper right eye element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.
erf3	Array	[ ]	Rotate the lower left eye element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.
brf1	Array	[ ]	Rotate the upper left eye ball element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.
brf2	Array	[ ]	Rotate the upper right eye ball element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.
brf3	Array	[ ]	Rotate the lower left eye ball element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.
bodyColor	String	#000000	Color of QR code body as HEX value.
bgColor	String	#ffffff	Color of QR code background as HEX value. Note: the background should always have a lighter color to be scanable with all devices.
eye1Color	String	#000000	Color of the upper left eye as HEX value.
eye2Color	String	#000000	Color of the upper right eye as HEX value.
eye3Color	String	#000000	Color of the lower left eye as HEX value.
eyeBall1Color	String	#000000	Color of the upper left eye ball as HEX value.
eyeBall2Color	String	#000000	Color of the upper right eye ball as HEX value.
eyeBall3Color	String	#000000	Color of the lower left eye ball as HEX value.
gradientColor1	String	null	Color 1 for gradient color of body as HEX.
gradientColor2	String	null	Color 2 for gradient color of body as HEX.
gradientType	String	linear	Gradient type for color of body. Value can be "linear" or "radial".
gradientOnEyes	Boolean	false	Disable individual colors for the eye elements and set the gradient color for the complete QR code.
logo	String	null	The filename of an uploaded image or an image URL. When using an uploaded image instead of an URL please look at the upload API (see below) and use the given "file" value for this parameter.
logoMode	String	default	Set this value to "clean" to remove the background behind the integrated logo.

Examples

Request URL	/qr/custom
Request Method	POST
Request Body	`{"data":"https://www.qrcode-monkey.com", "config":{ "body":"circle", "logo":"#facebook"}, "size":300, "download":false, "file":"svg" }`
Response

Request URL	/qr/custom
Request Method	POST
Request Body	{"data":"https://www.qrcode-monkey.com", "config":{ "body":"rounded-pointed", "eye":"frame14", "eyeBall":"ball16", "erf1":[], "erf2":["fh"], "erf3":["fv"], "brf1":[], "brf2":["fh"], "brf3":["fv"], "bodyColor":"#5C8B29", "bgColor":"#FFFFFF", "eye1Color":"#3F6B2B", "eye2Color":"#3F6B2B", "eye3Color":"#3F6B2B", "eyeBall1Color":"#60A541", "eyeBall2Color":"#60A541", "eyeBall3Color":"#60A541", "gradientColor1":"#5C8B29", "gradientColor2":"#25492F", "gradientType":"radial", "gradientOnEyes":false, "logo":""}, "size":300, "download":false, "file":"svg" }
Response