API-Dokumentation

Schnellstart

Mit dem QR Cake API können QR Cake Benutzer ihr Konto QR Codes verwalten.

Authentifizierung

Erstellen Sie in Ihrem Dashboard einen API-Schlüssel und senden Sie ihn im Autorisierungsheader.

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

Verwalten Sie API-Schlüssel Dashboard API Schlüssel.

API Anforderungstester

Testen Sie Endpunkte direkt von dieser Seite aus. Geben Sie Ihren API-Schlüssel ein, wählen Sie einen Endpunkt aus und überprüfen Sie die Live-Antwort.

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

Terminologie

Anforderungstexte (POST/PUT)

Für POST- und PUT-Anfragen müssen die Anfragetexte mit Zeichenfolgen versehen sein. Wenn Sie JSON senden, übergeben Sie eine JSON-Zeichenfolge (z. B 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": {}
}

Produkte = QR Codes.

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

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

{
  "message": {}
}

Der Anforderungstext von POST muss mit einem String versehen sein (z. B. 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": {}
}

Der Anforderungstext von PUT muss mit einem String versehen sein.

Unterstützte QR-Typen

Verwenden Sie diese Metadatentypen beim Erstellen oder Aktualisieren von QR-Produkten.

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

Beginnen Sie mit dynamische QR-Codes Und veränderliche QR-Codes auf unserer Homepage.