Τεκμηρίωση API δυναμικών κωδικών QR | QR Cake

Δημιουργήστε, ενημερώστε και διαχειριστείτε δυναμικούς κωδικούς QR με το API του QR Cake. Χρησιμοποιήστε κλειδιά API, δοκιμάστε αιτήματα και συνδέστε ροές εργασίας QR με τα δικά σας εργαλεία.

JSON REST APIΔημιουργία δυναμικών QRΈλεγχος ταυτότητας με κλειδί API

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

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

Βασικό URL

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

Τελικά σημεία

Λίστα κωδικών QRGET

/product

Λήψη κωδικού QRGET

/product/{productId}

Δημιουργία κωδικού QRPOST

/product

Ενημέρωση κωδικού QRPUT

/product/{productId}

Διαγραφή κωδικού QRDELETE

/product/{productId}

ΔικαιώματαGET

/permission

Έλεγχος ταυτότητας

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

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

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

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

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

Διαδραστικός δοκιμαστής API

Εκτελέστε αιτήματα απευθείας από το πρόγραμμα περιήγησής σας προς το επιλεγμένο τελικό σημείο του API του QR Cake.

GET

Τελικό σημείο

Κλειδί API

x-api-key: YOUR_API_KEY

Επιλυμένο URL

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

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

Ορολογία

Προϊόντα

Κωδικοί QR

Χρήστες

Λογαριασμοί QR Cake

Σώματα αιτήματος (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),
});

GET

Λίστα κωδικών QR

Επιστρέφει τους κωδικούς QR που είναι προσβάσιμοι από το κλειδί 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.

GET

Λήψη κωδικού QR

Επιστρέφει έναν κωδικό QR.

Άνοιγμα στο 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

Δημιουργεί ένα νέο προϊόν κωδικού QR.

Άνοιγμα στο 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 αιτήματος πρέπει να σταλεί ως string (για παράδειγμα, JSON.stringify(payload)).

PUT

Ενημέρωση κωδικού QR

Ενημερώνει έναν υπάρχοντα κωδικό QR (product).

Άνοιγμα στο 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 αιτήματος πρέπει να σταλεί ως string.

DELETE

Διαγραφή κωδικού QR

Διαγράφει έναν κωδικό QR.

Άνοιγμα στο 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 και τους επεξεργάσιμους κωδικούς QR.