API-dokumentation

Resurser och guider för utvecklare som vill integrera QR Cake.

JSON REST APISkapa dynamiska QR-koderBearer-autentisering

Skapa API-nyckel

Snabbstart

QR Cake API låter QR Cake-användare hantera QR-koder i sitt konto.

Bas-URL

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

Slutpunkter

Lista QR-koderGET

/user/product

Skaffa en QR-kodGET

/product/{productId}

Skapa en QR-kodPOST

/product

Uppdatera en QR-kodPUT

/product/{productId}

Radera en QR-kodDELETE

/product/{productId}

BehörigheterGET

/permission

Autentisering

Skapa en API-nyckel i din dashboard och skicka den i Authorization-headern.

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

Hantera API-nycklar i Dashboardens API-nycklar.

API-testare

Testa endpoints direkt på den här sidan. Ange din API-nyckel, välj en endpoint och granska svaret i realtid.

Interaktiv API-testare

Kör förfrågningar direkt i webbläsaren mot den valda QR Cake API-endpointen.

GET

Endpoint

API-nyckel

Authorization: Bearer <API Key>

Resulterande URL

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

Kör en förfrågan för att se status och svar här i realtid.

Terminologi

Produkter

QR-koder

Användare

QR Cake-konton

Begärandekroppar (POST/PUT)

För POST- och PUT-förfrågningar måste begärandekroppen serialiseras som en sträng. Om du skickar JSON, skicka en JSON-sträng (till exempel JSON.stringify(payload)).

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

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

GET

Lista QR-koder

Listar QR-koderna som API-nyckeln har tillgång till.

Öppna i GitBook

Sökväg: /user/product

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

Begärandedetaljer

Rubriker

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

Produkter = QR-koder.

GET

Skaffa en QR-kod

Hämtar en QR-kod.

Öppna i GitBook

Sökväg: /product/{productId}

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

Begärandedetaljer

Sökvägsparametrar

productId (string)

Rubriker

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Skapa en QR-kod

Skapar en ny QR-kodprodukt.

Öppna i GitBook

Sökväg: /product

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

Begärandedetaljer

Rubriker

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

Mall för begärandekropp

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST-begärandekroppen måste serialiseras som en sträng (till exempel JSON.stringify(payload)).

PUT

Uppdatera en QR-kod

Uppdaterar en befintlig QR-kod (produkt).

Öppna i GitBook

Sökväg: /product/{productId}

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

Begärandedetaljer

Sökvägsparametrar

productId (string)

Rubriker

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

Mall för begärandekropp

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

PUT-begärandekroppen måste serialiseras som en sträng.

DELETE

Radera en QR-kod

Raderar en QR-kod.

Öppna i GitBook

Sökväg: /product/{productId}

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

Begärandedetaljer

Sökvägsparametrar

productId (string)

Rubriker

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

Svar

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Behörigheter

Returnerar de behörigheter som API-nyckeln har.

Öppna i GitBook

Sökväg: /permission

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

Begärandedetaljer

Rubriker

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

QR-typer som stöds

Använd dessa metadatatyper när du skapar eller uppdaterar QR-produkter.

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

Börja på vår startsida med dynamiska QR-koder och redigerbara QR-koder.