API dokumentacija

Izradite, ažurirajte i upravljajte dinamičkim QR kodovima pomoću QR Cake API-ja. Koristite API ključeve, testirajte zahtjeve i povežite QR tokove rada s vlastitim alatima.

JSON REST APIDinamičko stvaranje QR-aBearer autorizacija

Brzi početak

QR Cake API omogućuje QR Cake korisnicima upravljanje QR kodovima na svom računu.

Bazni URL

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

Krajnje točke

/user/product

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

Autentifikacija

Izradite API ključ na svojoj nadzornoj ploči i pošaljite ga u zaglavlju Authorization.

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

Upravljanje API ključevima API ključevi na nadzornoj ploči.

API tester

Testirajte krajnje točke izravno s ove stranice. Unesite svoj API ključ, odaberite krajnju točku i pregledajte odgovor uživo.

Interaktivni API tester

Pokrenite zahtjeve izravno iz svog preglednika na odabranu krajnju točku QR Cake API-ja.

GET

Krajnja točka

API ključ

Authorization: Bearer YOUR_API_KEY

Razriješeni URL

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

Pokrenite zahtjev da biste ovdje vidjeli status uživo i izlaz odgovora.

Terminologija

Proizvodi

QR kodovi

Korisnici

QR Cake računi

Tijela zahtjeva (POST/PUT)

Za zahtjeve POST i PUT tijela zahtjeva moraju biti stringirana. Ako šaljete JSON, proslijedite JSON niz (na primjer JSON.stringify(payload)).

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

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

GET

Popis QR kodova

Navodi QR kodove dostupne API ključu.

Otvorite u GitBooku

Put: /user/product

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

Detalji zahtjeva

Zaglavlja

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

Odgovori

200 OK

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

401 Unauthorized

{
  "message": {}
}

Proizvodi = QR kodovi.

GET

Dohvati QR kod

Dohvaća jedan QR kod.

Otvorite u GitBooku

Put: /product/{productId}

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

Detalji zahtjeva

Parametri putanje

productId (string)

Zaglavlja

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

Odgovori

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Izradi QR kod

Stvara novi proizvod s QR kodom.

Otvorite u GitBooku

Put: /product

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

Detalji zahtjeva

Zaglavlja

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

Šablona tijela

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

Odgovori

200 OK

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

401 Unauthorized

{
  "message": {}
}

Tijelo zahtjeva POST mora biti stringificirano (na primjer, JSON.stringify(payload)).

PUT

Ažuriraj QR kod

Ažurira postojeći QR kod (proizvod).

Otvorite u GitBooku

Put: /product/{productId}

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

Detalji zahtjeva

Parametri putanje

productId (string)

Zaglavlja

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

Šablona tijela

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

Odgovori

200 OK

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

401 Unauthorized

{
  "message": {}
}

Tijelo zahtjeva PUT mora biti stringificirano.

DELETE

Izbriši QR kod

Briše QR kod.

Otvorite u GitBooku

Put: /product/{productId}

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

Detalji zahtjeva

Parametri putanje

productId (string)

Zaglavlja

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

Odgovori

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Dozvole

Vraća dopuštenja dodijeljena API ključu.

Otvorite u GitBooku

Put: /permission

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

Detalji zahtjeva

Zaglavlja

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

Odgovori

200 OK

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

401 Unauthorized

{
  "message": {}
}

Podržane vrste QR-a

Koristite ove vrste metapodataka prilikom izrade ili ažuriranja QR proizvoda.

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

Započnite s dinamičkim QR kodovima i promjenjivim QR kodovima na našoj početnoj stranici.