Documentazione API

Avvio rapido

L'API di QR Cake consente agli utenti di QR Cake di gestire i QR code del proprio account.

Autenticazione

Crea una chiave API nella dashboard e inviala nell'header Authorization.

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

Gestisci le chiavi API in Chiavi API nella dashboard.

Tester richieste API

Testa gli endpoint direttamente da questa pagina. Inserisci la tua chiave API, seleziona un endpoint e controlla la risposta in tempo reale.

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

Terminologia

Body delle richieste (POST/PUT)

Per le richieste POST e PUT, il body deve essere serializzato come stringa. Se invii JSON, passa una stringa JSON (ad esempio 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": {}
}

Prodotti = QR code.

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

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

{
  "message": {}
}

Il body della richiesta POST deve essere serializzato come stringa (ad esempio 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": {}
}

Il body della richiesta PUT deve essere serializzato come stringa.

Tipi di QR supportati

Utilizza questi tipi di metadati durante la creazione o l'aggiornamento di prodotti QR.

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

Inizia dalla nostra pagina iniziale con QR code dinamici e QR code modificabili.