Tài liệu API mã QR động | QR Cake

Tạo, cập nhật và quản lý mã QR động bằng QR Cake API. Sử dụng khóa API, kiểm thử yêu cầu và kết nối luồng làm việc QR với công cụ của riêng bạn.

JSON REST APITạo mã QR độngXác thực bằng khóa 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ọ.

URL gốc

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

Endpoint

/product

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

Xác thực

Tạo một khóa API trong bảng điều khiển của bạn và gửi khóa đó trong header x-api-key.

x-api-key: <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.

Trình kiểm tra API tương tác

Chạy yêu cầu trực tiếp từ trình duyệt của bạn tới endpoint QR Cake API đã chọn.

GET

Endpoint

Khóa API

x-api-key: YOUR_API_KEY

URL hoàn chỉnh

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

Chạy một yêu cầu để xem trạng thái trực tiếp và nội dung phản hồi tại đây.

Thuật ngữ

Các sản phẩm

Mã QR

Người dùng

Tài khoản QR Cake

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),
});

GET

Danh sách mã QR

Liệt kê các mã QR mà khóa API có thể truy cập.

Mở trong GitBook

Đường dẫn: /product

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

Chi tiết yêu cầu

Header

x-api-key: <API Key>
Accept: application/json

Phản hồi

200 OK

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

401 Unauthorized

{
  "message": {}
}

Products = Mã QR.

GET

Lấy một mã QR

Lấy một mã QR.

Mở trong GitBook

Đường dẫn: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

Chi tiết yêu cầu

Tham số đường dẫn

productId (string)

Header

x-api-key: <API Key>
Accept: application/json

Phản hồi

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Tạo mã QR

Tạo một sản phẩm mã QR mới.

Mở trong GitBook

Đường dẫn: /product

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

Chi tiết yêu cầu

Header

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

Mẫu nội dung

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

Phản hồi

200 OK

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

401 Unauthorized

{
  "message": {}
}

Nội dung yêu cầu POST phải được chuyển thành chuỗi (ví dụ: JSON.stringify(payload)).

PUT

Cập nhật mã QR

Cập nhật mã QR hiện có (sản phẩm).

Mở trong GitBook

Đường dẫn: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

Chi tiết yêu cầu

Tham số đường dẫn

productId (string)

Header

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

Mẫu nội dung

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

Phản hồi

200 OK

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

401 Unauthorized

{
  "message": {}
}

Nội dung yêu cầu PUT phải được chuyển thành chuỗi.

DELETE

Xóa mã QR

Xóa một mã QR.

Mở trong GitBook

Đường dẫn: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

Chi tiết yêu cầu

Tham số đường dẫn

productId (string)

Header

x-api-key: <API Key>
Accept: application/json

Phản hồi

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Quyền

Trả về các quyền được cấp cho khóa API.

Mở trong GitBook

Đường dẫn: /permission

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

Chi tiết yêu cầu

Header

x-api-key: <API Key>
Accept: application/json

Phản hồi

200 OK

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

401 Unauthorized

{
  "message": {}
}

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, review

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.