API-Dokumentation für dynamische QR-Codes | QR Cake

Erstellen, aktualisieren und verwalten Sie dynamische QR-Codes mit der QR Cake-API. Nutzen Sie API-Schlüssel, testen Sie Anfragen und verbinden Sie QR-Workflows mit Ihren eigenen Tools.

JSON REST APIDynamische QR-ErstellungBearer-Autorisierung

Schnellstart

Mit der QR Cake-API können QR Cake-Nutzer die QR-Codes ihres Kontos verwalten.

Basis-URL

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

Endpunkte

QR-Codes auflistenGET

/user/product

QR-Code abrufenGET

/product/{productId}

QR-Code erstellenPOST

/product

QR-Code aktualisierenPUT

/product/{productId}

QR-Code löschenDELETE

/product/{productId}

BerechtigungenGET

/permission

Authentifizierung

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

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

API-Schlüssel verwalten in Dashboard-API-Schlüssel.

API-Anfrage-Tester

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

Interaktiver API-Tester

Senden Sie Anfragen direkt aus Ihrem Browser an den ausgewählten QR Cake-API-Endpunkt.

GET

Endpunkt

API-Schlüssel

Authorization: Bearer YOUR_API_KEY

Aufgelöste URL

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

Führen Sie hier eine Anfrage aus, um Live-Status und Antwort zu sehen.

Terminologie

Produkte

QR-Codes

Benutzer

QR Cake-Konten

Anfragetexte (POST/PUT)

Für POST- und PUT-Anfragen müssen Anfragetexte als String übergeben werden. Wenn Sie JSON senden, übergeben Sie einen JSON-String (z. B. JSON.stringify(payload)).

const payload = { redirect: "https://example.com", metadata: {} };

await fetch(url, {
  method: "POST",
  body: JSON.stringify(payload),
});

GET

QR-Codes auflisten

Listet die QR-Codes auf, auf die der API-Schlüssel Zugriff hat.

In GitBook öffnen

Pfad: /user/product

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

Anfragedetails

Header

Authorization: Bearer <API Key>
Accept: application/json

Antworten

200 OK

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

401 Unauthorized

{
  "message": {}
}

Produkte = QR-Codes.

GET

QR-Code abrufen

Ruft einen QR-Code ab.

In GitBook öffnen

Pfad: /product/{productId}

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

Anfragedetails

Pfadparameter

productId (string)

Header

Authorization: Bearer <API Key>
Accept: application/json

Antworten

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

QR-Code erstellen

Erstellt ein neues QR-Code-Produkt.

In GitBook öffnen

Pfad: /product

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

Anfragedetails

Header

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

Body-Vorlage

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

Antworten

200 OK

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

401 Unauthorized

{
  "message": {}
}

Der POST-Anfragetext muss als String übergeben werden (z. B. JSON.stringify(payload)).

PUT

QR-Code aktualisieren

Aktualisiert einen vorhandenen QR-Code (Produkt).

In GitBook öffnen

Pfad: /product/{productId}

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

Anfragedetails

Pfadparameter

productId (string)

Header

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

Body-Vorlage

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

Antworten

200 OK

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

401 Unauthorized

{
  "message": {}
}

Der PUT-Anfragetext muss als String übergeben werden.

DELETE

QR-Code löschen

Löscht einen QR-Code.

In GitBook öffnen

Pfad: /product/{productId}

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

Anfragedetails

Pfadparameter

productId (string)

Header

Authorization: Bearer <API Key>
Accept: application/json

Antworten

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Berechtigungen

Gibt die Berechtigungen zurück, die dem API-Schlüssel gewährt wurden.

In GitBook öffnen

Pfad: /permission

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

Anfragedetails

Header

Authorization: Bearer <API Key>
Accept: application/json

Antworten

200 OK

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

401 Unauthorized

{
  "message": {}
}

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 dynamischen QR-Codes und veränderbaren QR-Codes auf unserer Startseite.