https://gen-endpoint.com, an endpoint path for this API, such as /api/qr/generate, would be accessible at https://gen-endpoint.com/api/qr/generate. You can use the "Try it out" section for each endpoint or use tools like curl, Postman, or your browser's address bar (for GET requests) to interact with them./api/qr/generate
Generate QR code image with customizable options.
Show Static Examples
Example Request Body:
{
"data": "https://www.example.com",
"size": 256,
"format": "png",
"errorCorrection": "M",
"foregroundColor": "#000000",
"backgroundColor": "#FFFFFF",
"margin": 4
}Example Response:
{
"id": "qr_456",
"imageUrl": "/api/qr/qr_456/image.png",
"data": "https://www.example.com",
"size": 256,
"format": "png",
"createdAt": "2024-08-16T12:00:00Z",
"downloadUrls": {
"png": "/api/qr/qr_456/download.png",
"svg": "/api/qr/qr_456/download.svg",
"pdf": "/api/qr/qr_456/download.pdf"
}
}/api/qr/{qrId}
Get QR code metadata and download links. Replace {qrId} with an actual ID like `qr_456`.
Show Static Examples
Example Response:
{
"id": "qr_456",
"data": "https://www.example.com",
"imageUrl": "/api/qr/qr_456/image.png",
"downloadUrls": {
"png": "/api/qr/qr_456/download.png",
"svg": "/api/qr/qr_456/download.svg",
"pdf": "/api/qr/qr_456/download.pdf"
},
"scanCount": 45,
"createdAt": "2024-08-16T12:00:00Z"
}Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).
/api/qr/{qrId}/image.png
Retrieve the QR code as a PNG image. Replace {qrId} with an actual ID like `qr_456`.
Show Static Examples
Example Response:
(Binary PNG image data)Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).
/api/qr/{qrId}/download.png
Download the QR code as a PNG file. Replace {qrId} with an actual ID like `qr_456`.
Show Static Examples
Example Response:
(File download of PNG image)Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).
/api/qr/{qrId}/download.svg
Download the QR code as an SVG file. Replace {qrId} with an actual ID like `qr_456`.
Show Static Examples
Example Response:
(File download of SVG image)Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).
/api/qr/{qrId}/download.pdf
Download the QR code as a PDF file. Replace {qrId} with an actual ID like `qr_456`.
Show Static Examples
Example Response:
(File download of PDF document)Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).
/api/qr/batch
Generate multiple QR codes in batch.
Show Static Examples
Example Request Body:
{
"codes": [
{"data": "https://example.com/page1", "filename": "page1"},
{"data": "https://example.com/page2", "filename": "page2"}
],
"format": "png",
"size": 256
}Example Response:
{
"batchId": "batch_789",
"status": "processing",
"totalCodes": 2,
"estimatedCompletion": "2024-08-16T12:02:00Z"
}