Dinaminių QR kodų API dokumentacija | QR Cake

Kurkite, atnaujinkite ir tvarkykite dinaminius QR kodus naudodami QR Cake API. Naudokite API raktus, testuokite užklausas ir prijunkite QR procesus prie savo įrankių.

JSON REST APIDinaminis QR kūrimasBearer Autorizacija

Greita pradžia

QR Cake API leidžia QR Cake naudotojams valdyti savo paskyros QR kodus.

Bazinis URL

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

Galiniai taškai

Pateikti QR kodų sąrašąGET

/user/product

Gauti QR kodąGET

/product/{productId}

Sukurti QR kodąPOST

/product

Atnaujinti QR kodąPUT

/product/{productId}

Ištrinti QR kodąDELETE

/product/{productId}

LeidimaiGET

/permission

Autentifikavimas

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

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

Tvarkykite API raktus skiltyje Prietaisų skydelio API raktai.

API užklausų testeris

Išbandykite galinius taškus tiesiai iš šio puslapio. Įveskite savo API raktą, pasirinkite galinį tašką ir peržiūrėkite tiesioginį atsakymą.

Interaktyvus API testeris

Vykdykite užklausas tiesiai iš naršyklės į pasirinktą QR Cake API galinį tašką.

GET

Galinis taškas

API raktas

Authorization: Bearer YOUR_API_KEY

Galutinis URL

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

Paleiskite užklausą, kad čia pamatytumėte tiesioginę būseną ir atsakymo išvestį.

Terminija

Produktai

QR kodai

Vartotojai

QR Cake paskyros

Užklausos turinys (POST/PUT)

POST ir PUT užklausų turinys turi būti konvertuotas į eilutę (stringified). 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),
});

GET

Pateikti QR kodų sąrašą

Pateikia QR kodų, pasiekiamų API raktu, sąrašą.

Atidaryti GitBook

Kelias: /user/product

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

Užklausos informacija

Antraštės

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

Atsakymai

200 OK

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

401 Unauthorized

{
  "message": {}
}

Produktai = QR kodai.

GET

Gauti QR kodą

Gauna vieną QR kodą.

Atidaryti GitBook

Kelias: /product/{productId}

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

Užklausos informacija

Kelio parametrai

productId (string)

Antraštės

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

Atsakymai

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Sukurti QR kodą

Sukuria naują QR kodo produktą.

Atidaryti GitBook

Kelias: /product

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

Užklausos informacija

Antraštės

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

Turinio šablonas

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

Atsakymai

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST užklausos turinys turi būti konvertuotas į eilutę (pvz., JSON.stringify(payload)).

PUT

Atnaujinti QR kodą

Atnaujina esamą QR kodą (produktą).

Atidaryti GitBook

Kelias: /product/{productId}

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

Užklausos informacija

Kelio parametrai

productId (string)

Antraštės

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

Turinio šablonas

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

Atsakymai

200 OK

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

401 Unauthorized

{
  "message": {}
}

PUT užklausos turinys turi būti konvertuotas į eilutę.

DELETE

Ištrinti QR kodą

Ištrina QR kodą.

Atidaryti GitBook

Kelias: /product/{productId}

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

Užklausos informacija

Kelio parametrai

productId (string)

Antraštės

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

Atsakymai

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Leidimai

Grąžina API raktui suteiktus leidimus.

Atidaryti GitBook

Kelias: /permission

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

Užklausos informacija

Antraštės

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

Atsakymai

200 OK

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

401 Unauthorized

{
  "message": {}
}

Palaikomi QR tipai

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

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

Pradėkite nuo dinaminių QR kodų ir keičiamų QR kodų mūsų pagrindiniame puslapyje.