API dokumentai

Greita pradžia

QR Cake API leidžia QR Cake naudotojams valdyti savo paskyrą QR Codes.

Autentifikavimas

Sukurkite API raktą savo prietaisų skydelyje ir išsiųskite jį įgaliojimo antraštėje.

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

Tvarkyti API raktus Prietaisų skydelis API Mygtukai.

API Prašyti testerio

Išbandykite galutinius taškus tiesiai iš šio puslapio. Įveskite savo API raktą, pasirinkite galinį tašką ir patikrinkite tiesioginį atsakymą.

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

Terminija

Užklausos organai (POST/PUT)

POST ir PUT užklausų turinys turi būti suskirstytas. Jei siunčiate JSON, perduokite JSON eilutę (pvz., 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": {}
}

Produktai = 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": {}
}

POST užklausos turinys turi būti suskirstytas (pvz., 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 užklausos tekstas turi būti sutrumpintas.

Palaikomi QR tipai

Kurdami arba atnaujindami QR produktus naudokite šiuos metaduomenų tipus.

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

Pradėti nuo dinaminiai QR kodai ir keičiami QR kodai mūsų pagrindiniame puslapyje.