Tài liệu API

Bắt đầu nhanh

QR Cake API cho phép người dùng QR Cake quản lý các mã QR trong tài khoản của họ.

Xác thực

Tạo khóa API trong bảng điều khiển của bạn rồi gửi khóa đó trong tiêu đề Authorization.

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

Quản lý khóa API tại Khóa API trong bảng điều khiển.

Trình kiểm tra yêu cầu API

Kiểm tra trực tiếp các endpoint từ trang này. Nhập khóa API, chọn endpoint và xem phản hồi theo thời gian thực.

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

Thuật ngữ

Nội dung yêu cầu (POST/PUT)

Với các yêu cầu POST và PUT, nội dung yêu cầu phải được chuyển thành chuỗi. Nếu bạn gửi JSON, hãy truyền một chuỗi JSON (ví dụ: 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 = Mã 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 nội dung yêu cầu phải được xâu chuỗi (ví dụ: 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 nội dung yêu cầu phải được xâu chuỗi.

Các loại QR được hỗ trợ

Sử dụng các loại metadata này khi tạo hoặc cập nhật sản phẩm QR.

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

Bắt đầu với mã QR động và mã QR có thể chỉnh sửa trên trang chủ của chúng tôi.