API-dokumentaatio

Kehittäjäresurssit ja oppaat QR Caken integrointiin.

JSON REST APIDynaaminen QR-luontiBearer-todennus

Pika-aloitus

QR Cake API antaa QR Cake -käyttäjien hallita tilinsä QR-koodeja.

Perus-URL

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

Päätepisteet

Luettele QR-kooditGET

/user/product

Hae QR-koodiGET

/product/{productId}

Luo QR-koodiPOST

/product

Päivitä QR-koodiPUT

/product/{productId}

Poista QR-koodiDELETE

/product/{productId}

KäyttöoikeudetGET

/permission

Todennus

Luo API-avain hallintapaneelissa ja lähetä se Authorization-otsikossa.

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

Hallitse API-avainta Hallintapaneelin API-avaimet.

API-pyyntötesteri

Testaa päätepisteitä suoraan tältä sivulta. Anna API-avaimesi, valitse päätepiste ja tarkastele vastausta.

Interaktiivinen API-testeri

Suorita pyynnöt suoraan selaimesta valittuun QR Cake API -päätepisteeseen.

GET

Päätepiste

API-avain

Authorization: Bearer YOUR_API_KEY

Ratkaistu URL

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

Suorita pyyntö nähdäksesi live-tilan ja vastauksen tässä.

Terminologia

Tuotteet

QR-koodit

Käyttäjät

QR Cake -tilit

Pyyntörungot (POST/PUT)

POST- ja PUT-pyyntöjen runkotekstit on koodattava merkkijonoksi. Jos lähetät JSON-dataa, välitä JSON-merkkijono (esim. JSON.stringify(payload)).

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

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

GET

Luettele QR-koodit

Listaa API-avaimelle saatavilla olevat QR-koodit.

Avaa GitBookissa

Polku: /user/product

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

Pyynnön tiedot

Otsikot

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

Vastaukset

200 OK

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

401 Unauthorized

{
  "message": {}
}

Tuotteet = QR-koodit.

GET

Hae QR-koodi

Hakee yhden QR-koodin.

Avaa GitBookissa

Polku: /product/{productId}

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

Pyynnön tiedot

Polun parametrit

productId (string)

Otsikot

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

Vastaukset

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Luo QR-koodi

Luo uuden QR-koodituotteen.

Avaa GitBookissa

Polku: /product

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

Pyynnön tiedot

Otsikot

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

Runkomalli

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

Vastaukset

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST-pyynnön runko on koodattava merkkijonoksi (esim. JSON.stringify(payload)).

PUT

Päivitä QR-koodi

Päivittää olemassa olevan QR-koodin (tuotteen).

Avaa GitBookissa

Polku: /product/{productId}

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

Pyynnön tiedot

Polun parametrit

productId (string)

Otsikot

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

Runkomalli

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

Vastaukset

200 OK

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

401 Unauthorized

{
  "message": {}
}

PUT-pyynnön runko on koodattava merkkijonoksi.

DELETE

Poista QR-koodi

Poistaa QR-koodin.

Avaa GitBookissa

Polku: /product/{productId}

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

Pyynnön tiedot

Polun parametrit

productId (string)

Otsikot

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

Vastaukset

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Käyttöoikeudet

Palauttaa API-avaimelle myönnetyt käyttöoikeudet.

Avaa GitBookissa

Polku: /permission

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

Pyynnön tiedot

Otsikot

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

Vastaukset

200 OK

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

401 Unauthorized

{
  "message": {}
}

Tuetut QR-tyypit

Käytä näitä metatietotyyppejä, kun luot tai päivität QR-tuotteita.

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

Aloita etusivulta: dynaamiset QR-koodit ja vaihdettavat QR-koodit.