API dokumentācija

Ātrais sākums

QR Cake API ļauj QR Cake lietotājiem pārvaldīt sava konta QR kodus.

Autentifikācija

Informācijas panelī izveidojiet API atslēgu un nosūtiet to autorizācijas galvenē.

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

Pārvaldīt API atslēgas Informācijas paneļa API atslēgas.

API pieprasījumu testētājs

Pārbaudiet galapunktus tieši no šīs lapas. Ievadiet savu API atslēgu, atlasiet galapunktu un pārbaudiet tiešo atbildi.

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

Terminoloģija

Pieprasījuma struktūras (POST/PUT)

Pieprasījumiem POST un PUT pieprasījuma pamattekstiem jābūt stringificētiem. Ja sūtāt JSON, nosūtiet JSON virkni (piemēram, 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": {}
}

Produkti = QR kodi.

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

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

{
  "message": {}
}

POST pieprasījuma pamattekstam ir jābūt stringificētam (piemēram, 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 pieprasījuma pamattekstam ir jābūt stringificētam.

Atbalstītie QR veidi

Izmantojiet šos metadatu veidus, veidojot vai atjauninot QR produktus.

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

Sāciet ar dinamiskajiem QR kodiem un maināmajiem QR kodiem mūsu mājaslapā.