डायनामिक QR कोड API दस्तावेज़ | QR Cake

QR Cake API से डायनामिक QR कोड बनाएँ, अपडेट करें और प्रबंधित करें। API कुंजियों का उपयोग करें, अनुरोध जाँचें और QR वर्कफ़्लो को अपने टूल से जोड़ें।

JSON REST APIडायनामिक QR निर्माणAPI कुंजी प्रमाणीकरण

त्वरित शुरुआत

QR Cake API से QR Cake उपयोगकर्ता अपने खाते के QR कोड प्रबंधित कर सकते हैं।

बेस URL

https://api.qrcake.com/v1/product/api

एंडपॉइंट्स

QR कोड सूचीGET

/product

एक QR कोड प्राप्त करेंGET

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

प्रमाणीकरण

अपने डैशबोर्ड में एक API कुंजी बनाएं और उसे x-api-key हेडर में भेजें।

x-api-key: <API Key>
Content-Type: application/json

API कुंजियाँ यहाँ प्रबंधित करें: डैशबोर्ड API कुंजियाँ.

API अनुरोध परीक्षक

इसी पेज से सीधे एंडपॉइंट जाँचें। अपनी API कुंजी दर्ज करें, कोई एंडपॉइंट चुनें और लाइव रिस्पॉन्स देखें।

इंटरएक्टिव API परीक्षक

अनुरोध सीधे अपने ब्राउज़र से चुने हुए QR Cake API एंडपॉइंट पर चलाएँ।

GET

एंडपॉइंट

API कुंजी

x-api-key: YOUR_API_KEY

रिज़ॉल्व्ड URL

https://api.qrcake.com/v1/product/api/product

लाइव स्थिति और रिस्पॉन्स आउटपुट यहाँ देखने के लिए कोई अनुरोध चलाएँ।

शब्दावली

Products

QR कोड

Users

QR Cake खाते

रिक्वेस्ट बॉडी (POST/PUT)

POST और PUT अनुरोधों के लिए, रिक्वेस्ट बॉडी को स्ट्रिंगिफाई किया जाना चाहिए। यदि आप JSON भेज रहे हैं, तो JSON स्ट्रिंग पास करें (उदाहरण के लिए JSON.stringify(payload)).

const payload = { redirect: "https://example.com", metadata: {} };

await fetch(url, {
  method: "POST",
  body: JSON.stringify(payload),
});

GET

QR कोड सूची

API कुंजी के लिए सुलभ QR कोडों की सूची देता है।

GitBook में खोलें

पथ: /product

URL: https://api.qrcake.com/v1/product/api/product

रिक्वेस्ट विवरण

हेडर

x-api-key: <API Key>
Accept: application/json

रिस्पॉन्स

200 OK

[
  {
    "accountId": "string",
    "productId": "string",
    "userId": "string",
    "redirect": "string",
    "state": "ACTIVE",
    "metadata": {},
    "createdAt": 0,
    "updatedAt": 0
  }
]

401 Unauthorized

{
  "message": {}
}

Products = QR कोड।

GET

एक QR कोड प्राप्त करें

एक QR कोड प्राप्त करता है।

GitBook में खोलें

पथ: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

रिक्वेस्ट विवरण

पथ पैरामीटर

productId (string)

हेडर

x-api-key: <API Key>
Accept: application/json

रिस्पॉन्स

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

POST

एक QR कोड बनाएं

एक नया QR कोड उत्पाद बनाता है।

GitBook में खोलें

पथ: /product

URL: https://api.qrcake.com/v1/product/api/product

रिक्वेस्ट विवरण

हेडर

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

बॉडी टेम्पलेट

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

रिस्पॉन्स

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

POST रिक्वेस्ट बॉडी को स्ट्रिंगिफाई किया जाना चाहिए (उदाहरण के लिए, JSON.stringify(payload))।

PUT

QR कोड अपडेट करें

मौजूदा QR कोड (उत्पाद) को अपडेट करता है।

GitBook में खोलें

पथ: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

रिक्वेस्ट विवरण

पथ पैरामीटर

productId (string)

हेडर

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

बॉडी टेम्पलेट

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

रिस्पॉन्स

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

PUT रिक्वेस्ट बॉडी को स्ट्रिंगिफाई किया जाना चाहिए।

DELETE

QR कोड हटाएँ

एक QR कोड हटाता है।

GitBook में खोलें

पथ: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

रिक्वेस्ट विवरण

पथ पैरामीटर

productId (string)

हेडर

x-api-key: <API Key>
Accept: application/json

रिस्पॉन्स

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

अनुमतियाँ

API कुंजी को दी गई अनुमतियाँ लौटाता है।

GitBook में खोलें

पथ: /permission

URL: https://api.qrcake.com/v1/product/api/permission

रिक्वेस्ट विवरण

हेडर

x-api-key: <API Key>
Accept: application/json

रिस्पॉन्स

200 OK

{
  "success": true,
  "result": {
    "tier": "subscriber",
    "active": true,
    "analytics": true,
    "productLimit": 100,
    "productTotal": 3,
    "productActiveLimit": 100,
    "productActiveTotal": 3
  }
}

401 Unauthorized

{
  "message": {}
}

समर्थित QR प्रकार

QR उत्पाद बनाते या अपडेट करते समय इन मेटाडेटा प्रकारों का उपयोग करें।

redirect, link, image, video, file, pdf, audio, app, event, vCard, review

हमारे होमपेज पर डायनामिक QR कोड और परिवर्तनीय QR कोड से शुरू करें।