เอกสาร API สำหรับ QR Code แบบไดนามิก | QR Cake

สร้าง อัปเดต และจัดการ QR Code แบบไดนามิกด้วย QR Cake API ใช้คีย์ API ทดสอบคำขอ และเชื่อมงาน QR เข้ากับเครื่องมือของคุณเอง

JSON REST APIการสร้าง QR แบบไดนามิกยืนยันตัวตนด้วยคีย์ API

เริ่มต้นอย่างรวดเร็ว

QR Cake API ช่วยให้ผู้ใช้ QR Cake จัดการ QR Code ในบัญชีของตนได้

URL ตั้งต้น

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

เอนด์พอยต์

/product

/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 Code

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 Code

แสดงรายการ QR Code ที่คีย์ API นี้เข้าถึงได้

เปิดใน 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 Codes (สินค้า = QR Code)

GET

ดึงข้อมูล QR Code

ดึงข้อมูล QR Code หนึ่งรายการ

เปิดใน 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 Code

สร้างผลิตภัณฑ์ QR Code ใหม่

เปิดใน 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 Code

อัปเดต QR Code ที่มีอยู่ (ผลิตภัณฑ์)

เปิดใน 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 Code

ลบ QR Code หนึ่งรายการ

เปิดใน 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 Code แบบไดนามิก และ QR Code ที่เปลี่ยนแปลงได้ บนหน้าแรกของเรา