เอกสาร API

เอกสารและคู่มือสำหรับนักพัฒนาในการเชื่อมต่อกับ QR Cake

JSON REST APIการสร้าง QR แบบไดนามิกBearer Authorization

สร้างคีย์ API

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

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

URL ตั้งต้น

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

จุดสิ้นสุด

/user/product

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

การรับรองความถูกต้อง

สร้าง API key ในแดชบอร์ดของคุณ แล้วส่งไปในส่วนหัว Authorization

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

จัดการ API key ได้ที่ คีย์ API ในแดชบอร์ด.

ตัวทดสอบคำขอ API

ทดสอบเอนด์พอยต์ได้จากหน้านี้โดยตรง ป้อน API key เลือกเอนด์พอยต์ และดูผลลัพธ์แบบเรียลไทม์

ตัวทดสอบ API แบบโต้ตอบ

ส่งคำขอจากเบราว์เซอร์ของคุณไปยังเอนด์พอยต์ QR Cake API ที่เลือกได้โดยตรง

GET

จุดสิ้นสุด

API Key

Authorization: Bearer <API Key>

URL ที่จะเรียก

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

เรียกใช้คำขอเพื่อดูสถานะสดและเอาต์พุตการตอบกลับที่นี่

คำศัพท์

สินค้า

คิวอาร์โค้ด

ผู้ใช้

บัญชี 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

รายการคิวอาร์โค้ด

แสดงรายการคิวอาร์โค้ดที่ API key นี้เข้าถึงได้

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

GET

รับรหัส 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

สร้างผลิตภัณฑ์คิวอาร์โค้ดใหม่

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

อัปเดตคิวอาร์โค้ดเดิม (ผลิตภัณฑ์)

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

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

เริ่มต้นจาก คิวอาร์โค้ดแบบไดนามิก และ คิวอาร์โค้ดที่เปลี่ยนแปลงได้ บนหน้าแรกของเรา