Dokumentacija API za dinamične QR kode | QR Cake

Ustvarjajte, posodabljajte in upravljajte dinamične QR kode prek API QR Cake. Uporabljajte API ključe, preizkušajte zahteve in povežite delovne tokove QR z lastnimi orodji.

JSON REST APIDinamično ustvarjanje QRBearer overjanje

Hitri začetek

API QR Cake omogoča uporabnikom QR Cake, da upravljajo QR kode na svojem računu.

Osnovni URL

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

Končne točke

Seznam QR kodGET

/user/product

Pridobite QR kodoGET

/product/{productId}

Ustvari QR kodoPOST

/product

Posodobite QR kodoPUT

/product/{productId}

Izbrišite QR kodoDELETE

/product/{productId}

DovoljenjaGET

/permission

Overjanje

Ustvarite API ključ v svoji nadzorni plošči in ga pošljite v glavi Authorization.

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

API ključe upravljajte v Nadzorna plošča API ključev.

Tester API zahtev

Končne točke preizkušajte neposredno s te strani. Vnesite API ključ, izberite končno točko in si v živo oglejte odziv.

Interaktivni API tester

Pošljite zahteve neposredno iz brskalnika do izbrane končne točke API QR Cake.

GET

Končna točka

API ključ

Authorization: Bearer YOUR_API_KEY

Razrešen URL

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

Zaženite zahtevo, da tukaj vidite status in odziv v živo.

Terminologija

Izdelki

QR kode

Uporabniki

računi QR Cake

Telesa zahtev (POST/PUT)

Pri zahtevah POST in PUT mora biti telo zahteve niz. Če pošiljate JSON, posredujte niz JSON (na primer JSON.stringify(payload)).

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

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

GET

Seznam QR kod

Vrne seznam QR kod, do katerih ima API ključ dostop.

Odpri v GitBooku

Pot: /user/product

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

Podrobnosti zahteve

Glave

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

Odzivi

200 OK

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

401 Neoverjeno

{
  "message": {}
}

Izdelki = QR kode.

GET

Pridobite QR kodo

Pridobi eno QR kodo.

Odpri v GitBooku

Pot: /product/{productId}

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

Podrobnosti zahteve

Parametri poti

productId (string)

Glave

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

Odzivi

200 OK

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

401 Neoverjeno

{
  "message": {}
}

POST

Ustvari QR kodo

Ustvari nov izdelek s QR kodo.

Odpri v GitBooku

Pot: /product

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

Podrobnosti zahteve

Glave

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

Predloga telesa

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

Odzivi

200 OK

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

401 Neoverjeno

{
  "message": {}
}

Telo zahteve POST mora biti v nizu (na primer JSON.stringify(payload)).

PUT

Posodobite QR kodo

Posodobi obstoječo QR kodo (izdelek).

Odpri v GitBooku

Pot: /product/{productId}

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

Podrobnosti zahteve

Parametri poti

productId (string)

Glave

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

Predloga telesa

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

Odzivi

200 OK

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

401 Neoverjeno

{
  "message": {}
}

Telo zahteve PUT mora biti v nizu.

DELETE

Izbrišite QR kodo

Izbriše QR kodo.

Odpri v GitBooku

Pot: /product/{productId}

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

Podrobnosti zahteve

Parametri poti

productId (string)

Glave

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

Odzivi

200 OK

{
  "productId": "string"
}

401 Neoverjeno

{
  "message": {}
}

GET

Dovoljenja

Vrne dovoljenja, dodeljena ključu API.

Odpri v GitBooku

Pot: /permission

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

Podrobnosti zahteve

Glave

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

Odzivi

200 OK

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

401 Neoverjeno

{
  "message": {}
}

Podprte vrste QR

Te vrste metapodatkov uporabite pri ustvarjanju ali posodabljanju izdelkov QR.

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

Začnite z dinamičnimi QR kodami in spremenljivimi QR kodami na naši domači strani.