Effortless QR Code Automation at Scale with QR Zam API
With QR Zam API, you can seamlessly automate the creation of multiple QR codes, enabling you to scale your QR code projects with ease. Whether you require a batch of branded QR codes that align with your company's identity or sleek black and white QR codes for a minimalist touch, our API puts the power of choice in your hands.
Our pricing model for API usage is directly tied to the specific pricing plan you choose.
QR Zam's API employs industry-standard authentication mechanisms to ensure the security of your interactions with our service. To access the API and make authorized requests, you will need an API key.
By providing your unique API key in the request headers, you will be granted authorized access to QR Zam's API, allowing you to create and manage QR codes seamlessly. This authentication mechanism ensures the confidentiality and integrity of your data throughout your interactions with the API.
The responses from all API endpoints follow a standardized format. Regardless of the specific endpoint or request, the API response will include the following key elements:
| Name | Data Type | Description |
|---|
code | int | An integer code indicating the status of the response. |
message | string | A message providing additional information about the response, if applicable. |
timestamp | int | A Unix timestamp indicating when the response was generated. |
data | any | The main payload of the response, which may contain various types of data depending on the specific API endpoint. |
Base URL: https://api.qrzam.com/v1
GET /public/qrcodes/generate (Generate QR code image)
| Name | Type | Data Type | Description |
|---|
format | optional | enum | Image format of QR code. Enum:
0: SVG, 1: PNG, 2: JPG |
size | optional | int | Image size of QR code in pixel. (max: 2000) |
download | optional | bool | A boolean flag indicating if download is needed. |
data | required | string | The text content for the QR code. |
backColor | optional | string | The background color of the QR code. |
frontColor | optional | string | The foreground (text) color of the QR code. |
gradient | optional | enum | The type of gradient used in the QR code. Enum:
0: None, 1: Linear, 2: Radial |
gradientColor | optional | string | The color used for the gradient background, if applicable. |
pattern | optional | enum | The pattern type applied to the QR code. Enum:
0:  1:  2:  3:  4:  5:  6:  7:  8:  9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  |
markerOut | optional | enum | The marker type for the outer part of the QR code. Enum:
0:  1:  2:  3:  4:  5:  6:  7:  8:  9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  |
markerIn | optional | enum | The marker type for the inner part of the QR code. Enum:
0:  1:  2:  3:  4:  5:  6:  7:  8:  9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  |
markerOutColor | optional | string | The color for the outer marker, if applicable. |
markerInColor | optional | string | The color for the inner marker, if applicable. |
marker1OutColor | optional | string | The color for marker top right (outer), if applicable. |
marker1InColor | optional | string | The color for marker top right (inner), if applicable. |
marker2OutColor | optional | string | The color for marker bottom left (outer), if applicable. |
marker2InColor | optional | string | The color for marker bottom left (inner), if applicable. |
logo | optional | string | The URL or path to the logo image, if applicable. |
logoSize | optional | int | The size of the logo image, if applicable. (min: 0, max: 100) |
noLogoBg | optional | bool | Indicates whether the background is transparent when no logo is used. |
frame | optional | enum | The type of frame or border around the QR code. Enum:
0:  1:  2:  3:  4:  5:  6:  7:  |
frameLabel | optional | string | The label or text displayed within the QR code frame, if applicable. |
frameLabelSize | optional | int | The font size of the frame label, if applicable. (min: 0, max: 100) |
frameColor | optional | string | The color of the QR code frame, if applicable. |
| HTTP Code | Content-Type | Response |
|---|
200 | image/svg+xml, image/png, image/jpg | Image representation of QR code. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url 'https://api.qrzam.com/v1/public/qrcodes/generate?size=600&format=0&data=https:%2F%2Fqrzam.com&backColor=%23FFFFFF&frontColor=%23000000&markerOut=10&markerIn=6&markerOutColor=rgba(146,+177,+245,+1)&markerInColor=rgba(37,+99,+235,+1)&logoSize=80&noLogoBg=true&frame=3&frameLabel=%23MakeYourQR&frameLabelSize=100' \
--header 'X-PUBLIC-API-KEY: {publicApiKey}'
GET /admin/qrcodes (Retrieve QR codes)
| Name | Type | Data Type | Description |
|---|
search | optional | string | The keyword for searching QR codes. |
offset | optional | int | The offset for pagination (default: 0). |
limit | optional | int | The maximum number of results to return (default: 10). |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation list of QR code data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url 'https://api.qrzam.com/v1/admin/qrcodes?offset=0&limit=10' \
--header 'X-API-KEY: {secretApiKey}' \
{
"code": 0,
"message": "",
"timestamp": 1694565533,
"data": [
{
"id": "57a56db6-5e60-451b-89f2-cfc95930d370",
"createdAt": "2023-09-17T11:15:42.697Z",
"updatedAt": "2023-09-17T11:15:42.697Z",
"name": "Dynamic URL QR",
"active": true,
"dynamic": true,
"type": 0,
"data": {
"url": "https://qrzam.com"
},
"setting": {},
"design": {
"backColor": "#FFFFFF",
"frontColor": "#000000",
"markerOutColor": "#000000",
"markerInColor": "#000000"
}
}
]
}
POST /admin/qrcodes (Create QR code)
| Name | Type | Data Type | Description |
|---|
name | required | string | The name or label associated with the QR code. |
active | optional | bool | Indicates whether the QR code is active or not. |
dynamic | optional | bool | Indicates whether the QR code is dynamic or not. |
type | optional | enum | The type of QR code, specifying its purpose or content. Enum:
0: Link (Dynamic/Static)
1: Text (Static)
2: Email (Dynamic/Static)
3: Phone (Dynamic/Static)
4: Sms (Dynamic/Static)
5: Whatsapp (Dynamic/Static)
6: Skype (Dynamic/Static)
7: Zoom (Dynamic/Static)
8: Wifi (Static)
9: Vcard (Static)
10: Event (Static)
11: Paypal (Dynamic/Static)
12: Bitcoin (Dynamic/Static)
13: AppStore (Dynamic)
14: LandingPage (Dynamic)
16: Location (Dynamic/Static) |
data | required | any | The main payload of the QR code, which can contain various types of data depending on the specific QR code type. One of:
Link data, Text data, Email data, Phone data, SMS data, WhatsApp data, Skype data, Zoom data, Wifi data, vCard data, Event data, PayPal data, Bitcoin data, App Store data, Location data, Landing page data |
setting | optional | QR code setting data | Additional settings for the QR code's configuration. |
design | optional | QR code design data | The design-related settings for the QR code appearance. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of QR code data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request POST \
--url https://api.qrzam.com/v1/admin/qrcodes \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {secretApiKey}' \
--data '{
"name": "Dynamic Qr Code URL",
"active": true,
"dynamic": true,
"type": 0,
"data": {
"url": "https://qrzam.com"
},
"setting": {
"qrFolderId": "",
"expiryAt": "",
"password": ""
},
"design": {
"backColor": "#FFFFFF",
"frontColor": "#000000",
"bgImage": "",
"gradient": 0,
"gradientColor": "#FF89CF",
"pattern": 0,
"markerOut": 0,
"markerIn": 0,
"markerOutColor": "",
"markerInColor": "",
"marker1OutColor": "",
"marker1InColor": "",
"marker2OutColor": "",
"marker2InColor": "",
"logo": "",
"logoSize": 100,
"noLogoBg": false,
"frame": 0,
"frameLabel": "",
"frameLabelSize": 100,
"frameColor": "#000000"
}
}'
{
"code": 0,
"message": "",
"timestamp": 1695256938,
"data": {
"id": "5035fd56-8b5d-4d69-a060-e42ffad81691",
"createdAt": "2023-09-21T00:42:19.583Z",
"updatedAt": "2023-09-21T00:42:19.583Z",
"name": "Dynamic Qr Code URL",
"active": true,
"dynamic": true,
"type": 0,
"data": {
"url": "https://qrzam.com"
},
"setting": {},
"design": {
"backColor": "#FFFFFF",
"frontColor": "#000000",
"gradientColor": "#FF89CF",
"markerOutColor": "#000000",
"markerInColor": "#000000",
"marker1OutColor": "#000000",
"marker1InColor": "#000000",
"marker2OutColor": "#000000",
"marker2InColor": "#000000",
"logoSize": 100,
"frameLabelSize": 100,
"frameColor": "#000000"
}
}
}
PUT /admin/qrcodes/{qrCodeId} (Updates QR code)
| Name | Type | Data Type | Description |
|---|
qrCodeId | required | string | The unique identifier for the QR code. |
| Name | Type | Data Type | Description |
|---|
name | required | string | The name or label associated with the QR code. |
active | optional | bool | Indicates whether the QR code is active or not. |
type | optional | enum | The type of QR code, specifying its purpose or content. Enum:
0: Link (Dynamic/Static)
1: Text (Static)
2: Email (Dynamic/Static)
3: Phone (Dynamic/Static)
4: Sms (Dynamic/Static)
5: Whatsapp (Dynamic/Static)
6: Skype (Dynamic/Static)
7: Zoom (Dynamic/Static)
8: Wifi (Static)
9: Vcard (Static)
10: Event (Static)
11: Paypal (Dynamic/Static)
12: Bitcoin (Dynamic/Static)
13: AppStore (Dynamic)
14: LandingPage (Dynamic)
16: Location (Dynamic/Static) |
data | required | any | The main payload of the QR code, which can contain various types of data depending on the specific QR code type. One of:
Link data, Text data, Email data, Phone data, SMS data, WhatsApp data, Skype data, Zoom data, Wifi data, vCard data, Event data, PayPal data, Bitcoin data, App Store data, Location data, Landing page data |
setting | optional | QR code setting data | Additional settings for the QR code's configuration. |
design | optional | QR code design data | The design-related settings for the QR code appearance. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of QR code data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request PUT \
--url https://api.qrzam.com/v1/admin/qrcodes/{qrCodeId} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {secretApiKey}' \
--data '{
"name": "Dynamic Qr Code URL",
"active": true,
"dynamic": true,
"type": 0,
"data": {
"url": "https://qrzam.com"
},
"setting": {
"qrFolderId": "",
"expiryAt": "",
"password": ""
},
"design": {
"backColor": "#FFFFFF",
"frontColor": "#000000",
"bgImage": "",
"gradient": 0,
"gradientColor": "#FF89CF",
"pattern": 0,
"markerOut": 0,
"markerIn": 0,
"markerOutColor": "",
"markerInColor": "",
"marker1OutColor": "",
"marker1InColor": "",
"marker2OutColor": "",
"marker2InColor": "",
"logo": "",
"logoSize": 100,
"noLogoBg": false,
"frame": 0,
"frameLabel": "",
"frameLabelSize": 100,
"frameColor": "#000000"
}
}'
{
"code": 0,
"message": "",
"timestamp": 1695257028,
"data": {
"id": "5035fd56-8b5d-4d69-a060-e42ffad81691",
"createdAt": "2023-09-21T00:42:19.583Z",
"updatedAt": "2023-09-21T00:43:49.803Z",
"name": "Dynamic Qr Code URL",
"active": true,
"dynamic": true,
"type": 0,
"data": {
"url": "https://qrzam.com"
},
"setting": {},
"design": {
"backColor": "#FFFFFF",
"frontColor": "#000000",
"gradientColor": "#FF89CF",
"markerOutColor": "#000000",
"markerInColor": "#000000",
"marker1OutColor": "#000000",
"marker1InColor": "#000000",
"marker2OutColor": "#000000",
"marker2InColor": "#000000",
"logoSize": 100,
"frameLabelSize": 100,
"frameColor": "#000000"
}
}
}
GET /admin/qrcodes/{qrCodeId} (Retrieve QR code)
| Name | Type | Data Type | Description |
|---|
qrCodeId | required | string | The unique identifier for the QR code. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of QR code data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url https://api.qrzam.com/v1/admin/qrcodes/{qrCodeId} \
--header 'X-API-KEY: {secretApiKey}' \
{
"code": 0,
"message": "",
"timestamp": 1694134917,
"data": {
"id": "9b111e78-9247-4016-89b2-1e09cd3ee905",
"createdAt": "2023-08-25T09:55:00.721Z",
"updatedAt": "2023-08-25T10:11:34.000Z",
"name": "test 123",
"active": true,
"dynamic": true,
"type": 0,
"data": {
"url": "https://qrzam.com"
},
"setting": {
"expiryAt": "",
"password": ""
},
"design": {
"backColor": "#FFFFFF",
"frontColor": "#000000",
"customMarkerColor": false,
"diffMarkerColor": false,
"logo": "0",
"logoSize": 100,
"frameLabel": "SCAN ME",
"frameLabelSize": 100,
"frameColor": "#000000"
}
}
}
DELETE /admin/qrcodes/{qrCodeId} (Delete QR code)
| Name | Type | Data Type | Description |
|---|
qrCodeId | required | string | The unique identifier for the QR code. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation with empty data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request DELETE \
--url https://api.qrzam.com/v1/admin/qrcodes/{qrCodeId} \
--header 'X-API-KEY: {secretApiKey}'
{
"code": 0,
"message": "",
"timestamp": 1694134915
}
GET /admin/qrcodes/{qrCodeId}/generate (Generate QR code image)
| Name | Type | Data Type | Description |
|---|
qrCodeId | required | string | The unique identifier for the QR code. |
| Name | Type | Data Type | Description |
|---|
format | optional | enum | Image format of QR code. Enum:
0: SVG, 1: PNG, 2: JPG |
size | optional | int | Image size of QR code in pixel. (max: 2000) |
download | optional | bool | A boolean flag indicating if download is needed. |
| HTTP Code | Content-Type | Response |
|---|
200 | image/svg+xml, image/png, image/jpg | Image representation of QR code. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url 'https://api.qrzam.com/v1/admin/qrcodes/{qrCodeId}/generate?size=600&format=0&download=true' \
--header 'X-API-KEY: {secretApiKey}'
GET /admin/folders (Retrieve folders)
| Name | Type | Data Type | Description |
|---|
search | optional | string | The keyword for searching. |
offset | optional | int | The offset for pagination (default: 0). |
limit | optional | int | The maximum number of results to return (default: 10). |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation list of folder data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url 'https://api.qrzam.com/v1/admin/folders?offset=0&limit=10' \
--header 'X-API-KEY: {secretApiKey}'
{
"code": 0,
"message": "",
"timestamp": 1694565533,
"data": [
{
"id": "aa1b79e4-cb1a-41da-b9c9-d704f9a0882e",
"createdAt": "2023-08-11T14:29:30.864Z",
"name": "Campaign Green"
}
]
}
POST /admin/folders (Create folder)
| Name | Type | Data Type | Description |
|---|
name | required | string | The name or label associated with the folder. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of folder data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request POST \
--url https://api.qrzam.com/v1/admin/folders \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {secretApiKey}' \
--data '{
"name": "Campaign Green"
}'
{
"code": 0,
"message": "",
"timestamp": 1693958003,
"data": {
"id": "e385ff3e-e20c-4d8a-9321-ba2dcaf8f383",
"createdAt": "2023-09-05T23:53:23.729Z",
"name": "Campaign Green"
}
}
PUT /admin/folder/{folderId} (Updates folder)
| Name | Type | Data Type | Description |
|---|
folderId | required | string | The unique identifier for the folder. |
| Name | Type | Data Type | Description |
|---|
name | required | string | The name or label associated with the folder. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of folder data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request PUT \
--url https://api.qrzam.com/v1/admin/folders/aa1b79e4-cb1a-41da-b9c9-d704f9a0882e \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {secretApiKey}' \
--data '{
"name": "Campaign Green"
}'
{
"code": 0,
"message": "",
"timestamp": 1694992484,
"data": {
"id": "aa1b79e4-cb1a-41da-b9c9-d704f9a0882e",
"createdAt": "2023-08-11T14:29:30.864Z",
"name": "Campaign Green"
}
}
GET /admin/folder/{folderId} (Retrieve folder)
| Name | Type | Data Type | Description |
|---|
folderId | required | string | The unique identifier for the folder. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of folder data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url https://api.qrzam.com/v1/admin/folders/aa1b79e4-cb1a-41da-b9c9-d704f9a0882e \
--header 'X-API-KEY: {secretApiKey}'
{
"code": 0,
"message": "",
"timestamp": 1694992562,
"data": {
"id": "aa1b79e4-cb1a-41da-b9c9-d704f9a0882e",
"createdAt": "2023-08-11T14:29:30.864Z",
"name": "Campaign Green"
}
}
DELETE /admin/folders/{folderId} (Delete folder)
| Name | Type | Data Type | Description |
|---|
folderId | required | string | The unique identifier for the folder. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation with empty data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request DELETE \
--url https://api.qrzam.com/v1/admin/folders/e385ff3e-e20c-4d8a-9321-ba2dcaf8f383 \
--header 'X-API-KEY: {secretApiKey}'
{
"code": 0,
"message": "",
"timestamp": 1693961489
}
GET /admin/pages (Retrieve landing pages)
| Name | Type | Data Type | Description |
|---|
search | optional | string | The keyword for searching. |
offset | optional | int | The offset for pagination (default: 0). |
limit | optional | int | The maximum number of results to return (default: 10). |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation list of landing page data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url 'https://api.qrzam.com/v1/admin/pages?offset=0&limit=10' \
--header 'X-API-KEY: {secretApiKey}'
{
"code": 0,
"message": "",
"timestamp": 1694995061,
"data": [
{
"id": "68e685de-d887-479b-bbbe-480932b31c19",
"createdAt": "2023-04-20T14:55:53.844Z",
"updatedAt": "2023-08-13T09:19:03.492Z",
"name": "Example Digital Card",
"slug": "example-digital-card",
"url": "https://lp.qrzam.com/example-digital-card",
"type": 1,
"status": 1
}
]
}
POST /admin/pages (Create landing page)
| Name | Type | Data Type | Description |
|---|
name | required | string | The name associated with the landing page (e.g., "Example Digital Card"). |
slug | optional | string | A slug for the landing page (e.g., "example-digital-card"). |
type | required | enum | The type of landing page. Enum:
0: Custom HTML |
status | required | enum | The status of the landing page. Enum:
0: Draft
1: Publish |
meta | required | any | The main payload of the landing page, which can contain various types of data depending on the specific landing page type. One of:
Custom HTML |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of landing page data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request POST \
--url https://api.qrzam.com/v1/admin/pages \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {secretApiKey}' \
--data '{
"type": 0,
"status": 1,
"name": "my html page",
"meta": {
"setting": {
"html": "<!doctype html>\n <html>\n <head>\n <meta charset=\"UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <script src=\"https://cdn.tailwindcss.com\"></script>\n <style type=\"text/tailwindcss\">\n .link {\n @apply border rounded-full px-10 py-1 font-semibold;\n }\n </style>\n </head>\n <body>\n <div class=\"min-h-screen bg-gradient-to-r from-indigo-500 to-violet-400 flex flex-col gap-4 items-center text-center py-16 px-6 text-white\">\n <div class=\"w-40 h-40\">\n <img src=\"https://qrzam.com/s3/qr/b596d9e4-3dc1-43ba-8001-a024ca69e8d1/uploaded/QRZam%20Logo_Icon%20with%20Light%20BG_bah74t.png\" alt=\"avatar\"class=\"rounded-full border-2 shadow-md object-cover w-full h-full\" />\n </div>\n <div class=\"user\">\n <h2 class=\"font-bold text-lg\">@qrzam</h2>\n <p class=\"text-sm\">\n Experience accurate and effective QR code generator. Get started for FREE!\n </p>\n </div>\n <div class=\"flex flex-col gap-2 mt-4\">\n <a class=\"link\" href=\"#\">Website</a>\n <a class=\"link\" href=\"#\">Facebook</a>\n <a class=\"link\" href=\"#\">Twitter</a>\n <a class=\"link\" href=\"#\">Instagram</a>\n <a class=\"link\" href=\"#\">Youtube</a>\n </div>\n </div>\n </body>\n </html>"
}
}
}'
{
"code": 0,
"message": "",
"timestamp": 1707276523,
"data": {
"id": "2a23cb0f-2fc0-4f55-9c73-6d9e6f55722b",
"createdAt": "2024-02-07T03:28:43.790Z",
"updatedAt": "2024-02-07T03:28:43.790Z",
"name": "my html page",
"slug": "my-html-page",
"url": "https://lp.qrzam.com/my-html-page",
"type": 0,
"status": 1
}
}
PUT /admin/pages/{landingPageId} (Updates landing page)
| Name | Type | Data Type | Description |
|---|
landingPageId | required | string | The unique identifier for the landing page. |
| Name | Type | Data Type | Description |
|---|
name | required | string | The name associated with the landing page (e.g., "Example Digital Card"). |
slug | optional | string | A slug for the landing page (e.g., "example-digital-card"). |
type | required | enum | The type of landing page. Enum:
0: Custom HTML |
status | required | enum | The status of the landing page. Enum:
0: Draft
1: Publish |
meta | required | any | The main payload of the landing page, which can contain various types of data depending on the specific landing page type. One of:
Custom HTML |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of landing page data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request PUT \
--url https://api.qrzam.com/v1/admin/pages/2a23cb0f-2fc0-4f55-9c73-6d9e6f55722b \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: {secretApiKey}' \
--data '{
"type": 0,
"status": 1,
"name": "my html page",
"meta": {
"setting": {
"html": "<!doctype html>\n <html>\n <head>\n <meta charset=\"UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <script src=\"https://cdn.tailwindcss.com\"></script>\n <style type=\"text/tailwindcss\">\n .link {\n @apply border rounded-full px-10 py-1 font-semibold;\n }\n </style>\n </head>\n <body>\n <div class=\"min-h-screen bg-gradient-to-r from-indigo-500 to-violet-400 flex flex-col gap-4 items-center text-center py-16 px-6 text-white\">\n <div class=\"w-40 h-40\">\n <img src=\"https://qrzam.com/s3/qr/b596d9e4-3dc1-43ba-8001-a024ca69e8d1/uploaded/QRZam%20Logo_Icon%20with%20Light%20BG_bah74t.png\" alt=\"avatar\"class=\"rounded-full border-2 shadow-md object-cover w-full h-full\" />\n </div>\n <div class=\"user\">\n <h2 class=\"font-bold text-lg\">@qrzam</h2>\n <p class=\"text-sm\">\n Experience accurate and effective QR code generator. Get started for FREE!\n </p>\n </div>\n <div class=\"flex flex-col gap-2 mt-4\">\n <a class=\"link\" href=\"#\">Website</a>\n <a class=\"link\" href=\"#\">Facebook</a>\n <a class=\"link\" href=\"#\">Twitter</a>\n <a class=\"link\" href=\"#\">Instagram</a>\n <a class=\"link\" href=\"#\">Youtube</a>\n </div>\n </div>\n </body>\n </html>"
}
}
}'
{
"code": 0,
"message": "",
"timestamp": 1707276523,
"data": {
"id": "2a23cb0f-2fc0-4f55-9c73-6d9e6f55722b",
"createdAt": "2024-02-07T03:28:43.790Z",
"updatedAt": "2024-02-07T03:28:43.790Z",
"name": "my html page",
"slug": "my-html-page",
"url": "https://lp.qrzam.com/my-html-page",
"type": 0,
"status": 1
}
}
GET /admin/pages/{landingPageId} (Retrieve landing page)
| Name | Type | Data Type | Description |
|---|
landingPageId | required | string | The unique identifier for the landing page. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation of landing page data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request GET \
--url https://api.qrzam.com/v1/admin/pages/2a23cb0f-2fc0-4f55-9c73-6d9e6f55722b \
--header 'X-API-KEY: {secretApiKey}'
{
"code": 0,
"message": "",
"timestamp": 1707276849,
"data": {
"id": "2a23cb0f-2fc0-4f55-9c73-6d9e6f55722b",
"createdAt": "2024-02-07T03:28:43.790Z",
"updatedAt": "2024-02-07T03:30:03.401Z",
"name": "my html page",
"slug": "my-html-page",
"url": "https://lp.qrzam.com/my-html-page",
"type": 0,
"status": 1,
"meta": {
"setting": {
"html": "<!doctype html>\n <html>\n <head>\n <meta charset=\"UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <script src=\"https://cdn.tailwindcss.com\"></script>\n <style type=\"text/tailwindcss\">\n .link {\n @apply border rounded-full px-10 py-1 font-semibold;\n }\n </style>\n </head>\n <body>\n <div class=\"min-h-screen bg-gradient-to-r from-indigo-500 to-violet-400 flex flex-col gap-4 items-center text-center py-16 px-6 text-white\">\n <div class=\"w-40 h-40\">\n <img src=\"https://qrzam.com/s3/qr/b596d9e4-3dc1-43ba-8001-a024ca69e8d1/uploaded/QRZam%20Logo_Icon%20with%20Light%20BG_bah74t.png\" alt=\"avatar\"class=\"rounded-full border-2 shadow-md object-cover w-full h-full\" />\n </div>\n <div class=\"user\">\n <h2 class=\"font-bold text-lg\">@qrzam</h2>\n <p class=\"text-sm\">\n Experience accurate and effective QR code generator. Get started for FREE!\n </p>\n </div>\n <div class=\"flex flex-col gap-2 mt-4\">\n <a class=\"link\" href=\"#\">Website</a>\n <a class=\"link\" href=\"#\">Facebook</a>\n <a class=\"link\" href=\"#\">Twitter</a>\n <a class=\"link\" href=\"#\">Instagram</a>\n <a class=\"link\" href=\"#\">Youtube</a>\n </div>\n </div>\n </body>\n </html>"
}
}
}
}
DELETE /admin/pages/{landingPageId} (Delete landing page)
| Name | Type | Data Type | Description |
|---|
landingPageId | required | string | The unique identifier for the landing page. |
| HTTP Code | Content-Type | Response |
|---|
200 | application/json | JSON representation with empty data. |
400 | application/json | Bad request. Referrence response codes for details. |
500 | application/json | Error request. Referrence response codes for details. |
curl --request DELETE \
--url https://api.qrzam.com/v1/admin/pages/2a23cb0f-2fc0-4f55-9c73-6d9e6f55722b \
--header 'X-API-KEY: {secretApiKey}'
{
"code": 0,
"message": "",
"timestamp": 1707276849
}
| Code | Description |
|---|
0 | Indicates a successful response. |
1 | Internal error. |
2 | Bad request. |
3 | Upgrade require. |
| Name | Data Type | Description |
|---|
id | string | The unique identifier for the QR code. |
createdAt | string | The timestamp (ISO 8601) indicating when the QR code was created (e.g., "2023-09-17T11:15:42.697Z"). |
updatedAt | string | The timestamp (ISO 8601) indicating when the QR code was last updated (e.g., "2023-09-17T11:15:42.697Z"). |
name | string | The name or label associated with the QR code. |
active | bool | Indicates whether the QR code is active or not. |
dynamic | bool | Indicates whether the QR code is dynamic or not. |
type | enum | The type of QR code, specifying its purpose or content. Enum:
0: Link (Dynamic/Static)
1: Text (Static)
2: Email (Dynamic/Static)
3: Phone (Dynamic/Static)
4: Sms (Dynamic/Static)
5: Whatsapp (Dynamic/Static)
6: Skype (Dynamic/Static)
7: Zoom (Dynamic/Static)
8: Wifi (Static)
9: Vcard (Static)
10: Event (Static)
11: Paypal (Dynamic/Static)
12: Bitcoin (Dynamic/Static)
13: AppStore (Dynamic)
14: LandingPage (Dynamic)
16: Location (Dynamic/Static) |
data | any | The main payload of the QR code, which can contain various types of data depending on the specific QR code type. One of:
Link data, Text data, Email data, Phone data, SMS data, WhatsApp data, Skype data, Zoom data, Wifi data, vCard data, Event data, PayPal data, Bitcoin data, App Store data, Location data, Landing page data |
setting | QR code setting data | Additional settings for the QR code's configuration. |
design | QR code design data | The design-related settings for the QR code appearance. |
shortLink | QR code short link data (optional) | Data related to the short link associated with the QR code. |
| Name | Type | Data Type | Description |
|---|
url | required | string | The URL to which the QR code will link (e.g., "https://qrzam.com"). |
| Name | Type | Data Type | Description |
|---|
text | required | string | The text content for the QR code (e.g., "text"). |
| Name | Type | Data Type | Description |
|---|
email | required | string | The email address (e.g., "[email protected]"). |
subject | optional | string | The email subject. |
message | optional | string | The email message body. |
| Name | Type | Data Type | Description |
|---|
phone | required | string | The phone number (e.g., "+1234567890"). |
| Name | Type | Data Type | Description |
|---|
phone | required | string | The phone number (e.g., "+1234567890"). |
message | optional | string | The SMS message content. |
| Name | Type | Data Type | Description |
|---|
phone | required | string | The phone number (e.g., "+1234567890"). |
message | optional | string | The WhatsApp message content. |
| Name | Type | Data Type | Description |
|---|
type | required | enum | The type of Skype action, either "call" or "chat". |
username | required | string | The Skype username or recipient for the specified action. |
| Name | Type | Data Type | Description |
|---|
id | required | string | The Zoom meeting ID for the scheduled meeting. |
pass | optional | string | The password or passcode for accessing the meeting. |
| Name | Type | Data Type | Description |
|---|
type | optional | enum | The type of Wi-Fi security protocol, either "WEP" or "WPA". |
ssid | required | string | The SSID (network name) of the Wi-Fi network. |
pass | optional | string | The Wi-Fi password, if required. |
hidden | optional | bool | Indicates if the Wi-Fi network is hidden. |
| Name | Type | Data Type | Description |
|---|
title | optional | string | The title of the contact. |
firstname | required | string | The first name of the contact. |
lastname | required | string | The last name of the contact. |
mobile | optional | string | The mobile phone number of the contact. |
phone | optional | string | The phone number of the contact. |
email | optional | string | The email address of the contact. |
website | optional | string | The website URL of the contact. |
company | optional | string | The company or organization of the contact. |
jobTitle | optional | string | The job title or position of the contact. |
phoneOffice | optional | string | The office phone number of the contact. |
fax | optional | string | The fax number of the contact. |
address | optional | string | The street address of the contact. |
zip | optional | string | The postal or ZIP code of the contact's address. |
city | optional | string | The city of the contact's address. |
state | optional | string | The state or region of the contact's address. |
country | optional | string | The country of the contact's address. |
| Name | Type | Data Type | Description |
|---|
title | required | string | The title or name of the event. |
location | optional | string | The location or venue of the event. |
startTime | required | string | The start time of the event (ISO 8601 format). |
endTime | optional | string | The end time of the event (ISO 8601 format). |
note | optional | string | Additional notes or descriptions of the event. |
| Name | Type | Data Type | Description |
|---|
type | required | enum | The type of PayPal transaction. (Enum: _donations, _xclick, _cart) |
email | required | string | The PayPal email address (recipient). |
itemName | required | string | The name or description of the item. |
price | optional | float | The price of the item. |
currency | required | enum | The currency of the transaction. (Enum: USD, EUR, AUD, BRL, CAD, CNY, CZK, DKK, HKD, HUF, INR, ILS, JPY, MYR, MXN, TWD, NZD, NOK, PHP, PLN, GBP, RUB, SGD, SEK, CHF, THB) |
shipping | optional | float | The shipping cost (if applicable). |
tax | optional | float | The tax amount (if applicable). |
| Name | Type | Data Type | Description |
|---|
type | required | enum | The type of cryptocurrency. (Enum: bitcoin) |
address | required | string | The Bitcoin wallet address. |
amount | required | float | The amount of Bitcoin to send. |
message | optional | string | A message or note (if applicable). |
| Name | Type | Data Type | Description |
|---|
appStoreUrl | required | string | The URL to the app on the App Store. |
googlePlayUrl | required | string | The URL to the app on Google Play. |
| Name | Type | Data Type | Description |
|---|
name | optional | string | The name or label for the location. |
longitude | required | float | The longitude coordinate of the location. |
latitude | required | float | The latitude coordinate of the location. |
zoom | optional | int | The zoom level or scale for displaying the location. |
| Name | Type | Data Type | Description |
|---|
id | required | string | The identifier of the landing page. |
| Name | Data Type | Description |
|---|
qrFolderId | string | The folder ID associated with the QR code, if applicable. |
expiryAt | string | The expiration timestamp (ISO 8601) for the QR code, if set (e.g., "2023-09-17T11:15:42.697Z"). |
password | string | The password or security code for accessing the QR code, if set. |
| Name | Data Type | Description |
|---|
backColor | string | The background color of the QR code. |
frontColor | string | The foreground (text) color of the QR code. |
gradient | enum | The type of gradient used in the QR code. Enum:
0: None, 1: Linear, 2: Radial |
gradientColor | string | The color used for the gradient background, if applicable. |
pattern | enum | The pattern type applied to the QR code. Enum:
0: 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: |
markerOut | enum | The marker type for the outer part of the QR code. Enum:
0: 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: |
markerIn | enum | The marker type for the inner part of the QR code. Enum:
0: 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: |
markerOutColor | string | The color for the outer marker, if applicable. |
markerInColor | string | The color for the inner marker, if applicable. |
marker1OutColor | string | The color for marker top right (outer), if applicable. |
marker1InColor | string | The color for marker top right (inner), if applicable. |
marker2OutColor | string | The color for marker bottom left (outer), if applicable. |
marker2InColor | string | The color for marker bottom left (inner), if applicable. |
logo | string | The URL or path to the logo image, if applicable. |
logoSize | int | The size of the logo image, if applicable. (min: 0, max: 100) |
noLogoBg | bool | Indicates whether the background is transparent when no logo is used. |
frame | enum | The type of frame or border around the QR code. Enum:
0: 1: 2: 3: 4: 5: 6: 7: |
frameLabel | string | The label or text displayed within the QR code frame, if applicable. |
frameLabelSize | int | The font size of the frame label, if applicable. (min: 0, max: 100) |
frameColor | string | The color of the QR code frame, if applicable. |
| Name | Data Type | Description |
|---|
shortId | string | The unique identifier associated with the short link. |
shortUrl | string | The shortened URL generated for the QR code. |
| Name | Data Type | Description |
|---|
id | string | The unique identifier for the folder. |
createdAt | string | The timestamp (ISO 8601) indicating when the folder was created (e.g., "2023-09-17T11:15:42.697Z"). |
name | string | The name or label associated with the folder. |
| Name | Data Type | Description |
|---|
id | string | The unique identifier for the landing page (e.g., "68e685de-d887-479b-bbbe-480932b31c19"). |
createdAt | string (ISO 8601) | The timestamp (ISO 8601) indicating when the landing page was created (e.g., "2023-04-20T14:55:53.844Z"). |
updatedAt | string (ISO 8601) | The timestamp (ISO 8601) indicating when the landing page was last updated (e.g., "2023-08-13T09:19:03.492Z"). |
name | string | The name associated with the landing page (e.g., "Example Digital Card"). |
slug | string | A slug for the landing page (e.g., "example-digital-card"). |
url | string | URL for the landing page (e.g., "https://lp.qrzam.com/example-digital-card"). |
type | enum | The type of landing page. Enum:
0: Custom HTML
1: Digital Card
2: Coupon
3: Survey Form
4: App Store
5: Restaurant Menu |
status | enum | The status of the landing page. Enum:
0: Draft
1: Publish |
meta | any | The main payload of the landing page, which can contain various types of data depending on the specific landing page type (Only available with Retrieve landing page). |
| Name | Type | Data Type | Description |
|---|
html | required | string | Landing page HTML content. |