Τεκμηρίωση API

Γρήγορη εκκίνηση

Το API του QR Cake επιτρέπει στους χρήστες του QR Cake να διαχειρίζονται τους QR κωδικούς του λογαριασμού τους.

Αυθεντικοποίηση

Δημιουργήστε ένα κλειδί API από τον πίνακα ελέγχου σας και στείλτε το στην κεφαλίδα Authorization.

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

Διαχείριση API κλειδιών σε Κλειδιά API στον πίνακα ελέγχου.

Δοκιμαστής αιτημάτων API

Δοκιμάστε τελικά σημεία απευθείας από αυτή τη σελίδα. Εισαγάγετε το κλειδί API, επιλέξτε τελικό σημείο και ελέγξτε τη ζωντανή απόκριση.

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

Ορολογία

Σώματα αιτήματος (POST/PUT)

Για αιτήματα POST και PUT, τα σώματα πρέπει να αποστέλλονται ως string. Αν στέλνετε JSON, περάστε μια JSON συμβολοσειρά (για παράδειγμα 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 αιτήματος πρέπει να σταλεί ως string (για παράδειγμα, 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 αιτήματος πρέπει να σταλεί ως string.

Υποστηριζόμενοι τύποι QR

Χρησιμοποιήστε αυτούς τους τύπους μεταδεδομένων όταν δημιουργείτε ή ενημερώνετε QR προϊόντα.

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

Ξεκινήστε από την αρχική μας σελίδα με τους δυναμικούς QR κωδικούς και τους επεξεργάσιμους QR κωδικούς.