API-dokumentasjon

Rask start

QR Cake API lar QR Cake-brukere administrere QR-kodene i kontoen sin.

Autentisering

Opprett en API-nøkkel i dashbordet ditt og send den i Authorization-headeren.

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

Administrer API-nøkler i API-nøkler i dashbordet.

API-forespørselstester

Test endepunkter direkte fra denne siden. Skriv inn API-nøkkelen din, velg et endepunkt og inspiser live-responsen.

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

Terminologi

Innhold i forespørselen (POST/PUT)

For POST- og PUT-forespørsler må request body serialiseres som streng. Hvis du sender JSON, må du sende en JSON-streng (for eksempel 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": {}
}

Produkter = QR-koder.

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

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

{
  "message": {}
}

POST-forespørselens body må serialiseres som streng (for eksempel 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": {}
}

PUT-forespørselens body må serialiseres som streng.

Støttede QR-typer

Bruk disse metadatatypene når du oppretter eller oppdaterer QR-produkter.

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

Start med dynamiske QR-koder og redigerbare QR-koder på forsiden vår.