API ஆவணங்கள்

விரைவு தொடக்கம்

QR Cake API மூலம் உங்கள் கணக்கிலுள்ள QR குறியீடுகளை நிரல் முறையில் உருவாக்கவும், புதுப்பிக்கவும், நிர்வகிக்கவும் முடியும்.

அங்கீகாரம்

உங்கள் டாஷ்போர்டில் API விசையை உருவாக்கி, ஒவ்வொரு கோரிக்கையிலும் அதை Authorization header வழியாக அனுப்புங்கள்.

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

API விசைகளை நிர்வகிக்க டாஷ்போர்டில் உள்ள API விசைகள்.

API கோரிக்கை சோதனையாளர்

இந்தப் பக்கத்திலிருந்தே எண்ட்பாயிண்ட்களைச் சோதிக்கலாம். உங்கள் API விசையை உள்ளிட்டு, எண்ட்பாயிண்டைத் தேர்ந்தெடுத்து, பதிலை உடனே பாருங்கள்.

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

சொற்களஞ்சியம்

கோரிக்கை உட்பொருள்கள் (POST/PUT)

POST மற்றும் PUT கோரிக்கைகளில் request body ஒரு string ஆக serialise செய்யப்பட வேண்டும். உதாரணமாக JSON அனுப்பினால், JSON.stringify(payload) போன்ற வடிவில் string ஆகவே அனுப்புங்கள் (எடுத்துக்காட்டு JSON.stringify(payload)).

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

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

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

{
  "message": {}
}

இங்கே “Products” என்பது QR குறியீடுகளைக் குறிக்கிறது.

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

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

{
  "message": {}
}

POST request body string ஆக serialise செய்யப்பட வேண்டும். உதாரணம்: JSON.stringify(payload).

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

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

{
  "message": {}
}

PUT request body string ஆக serialise செய்யப்பட வேண்டும்.

ஆதரிக்கப்படும் QR வகைகள்

QR தயாரிப்புகளை உருவாக்கவும் புதுப்பிக்கவும் கீழே உள்ள metadata வகைகளைப் பயன்படுத்தலாம்.

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

தொடங்குவதற்கு எங்கள் முகப்புப் பக்கத்தில் உள்ள டைனமிக் QR குறியீடுகள் மற்றும் மாற்றக்கூடிய QR குறியீடுகள் பற்றிய விளக்கங்களைப் பாருங்கள்.