API दस्तावेज़

QR Cake को एकीकृत करने के लिए डेवलपर संसाधन और गाइड।

JSON REST APIडायनामिक QR निर्माणBearer प्राधिकरण

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

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

बेस URL

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

एंडपॉइंट्स

QR कोड सूचीGET

/user/product

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

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

प्रमाणीकरण

अपने डैशबोर्ड में एक API कुंजी बनाएं और इसे प्राधिकरण शीर्षलेख में भेजें।

Authorization: Bearer <API Key>
Content-Type: application/json

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

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

इस पृष्ठ से सीधे समापन बिंदुओं का परीक्षण करें। अपनी API कुंजी दर्ज करें, एक समापन बिंदु चुनें, और लाइव प्रतिक्रिया का निरीक्षण करें।

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

अनुरोधों को सीधे अपने ब्राउज़र से चयनित QR Cake API समापन बिंदु पर चलाएँ।

GET

एंडपॉइंट

API कुंजी

Authorization: Bearer YOUR_API_KEY

रिज़ॉल्व्ड URL

https://api.qrcake.com/v1/product/user/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 में खोलें

पथ: /user/product

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

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

हेडर

Authorization: Bearer <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/product/{productId}

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

पथ पैरामीटर

productId (string)

हेडर

Authorization: Bearer <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/product

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

हेडर

Authorization: Bearer <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/product/{productId}

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

पथ पैरामीटर

productId (string)

हेडर

Authorization: Bearer <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/product/{productId}

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

पथ पैरामीटर

productId (string)

हेडर

Authorization: Bearer <API Key>
Accept: application/json

जवाब

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

अनुमतियां

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

GitBook में खोलें

पथ: /permission

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

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

हेडर

Authorization: Bearer <API Key>
Accept: application/json

जवाब

200 OK

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

401 Unauthorized

{
  "message": {}
}

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

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

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

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