API-dokumentaatio

Kehittäjäresurssit ja oppaat QR Cake integrointiin.

JSON REST APIDynaaminen QR-luontiBearer Valtuutus

Luo API-avain

Pika-aloitus

QR Cake API antaa QR Cake-käyttäjien hallita tiliään QR Codes.

Tukikohta URL

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

Päätepisteet

/user/product

/product/{productId}

/product

/product/{productId}

Poista QR-koodiDELETE

/product/{productId}

KäyttöoikeudetGET

/permission

Todennus

Luo API-avain kojelautaan ja lähetä se Valtuutus-otsikossa.

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

Hallitse API avainta Kojelauta API Näppäimet.

API Pyydä testaajaa

Testaa päätepisteitä suoraan tältä sivulta. Anna API-avaimesi, valitse päätepiste ja tarkista live-vastaus.

Interaktiivinen API testaaja

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

GET

Päätepiste

API Avain

Authorization: Bearer <API Key>

Ratkaistu URL

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

Suorita pyyntö nähdäksesi live-tilan ja vastaustulosteen täällä.

Terminologia

Tuotteet

QR Codes

Käyttäjät

QR Cake tiliä

Pyyntöelimet (POST/PUT)

Pyyntöjen POST ja PUT osalta pyyntöjen runkotekstit on linjattava. Jos lähetät JSON-sanomaa, 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

Luettelo QR Codes

Luettelo QR Codes, joka on käytettävissä avaimella API.

Avaa GitBookissa

Polku: /user/product

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

Pyydä lisätietoja

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 Codes.

GET

Hanki QR-koodi

Hakee yhden QR-koodin.

Avaa GitBookissa

Polku: /product/{productId}

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

Pyydä lisätietoja

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

Pyydä lisätietoja

Otsikot

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

Vartalomalli

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

Pyynnön POST tekstin on oltava ketjutettu (esimerkiksi 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}

Pyydä lisätietoja

Polun parametrit

productId (string)

Otsikot

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

Vartalomalli

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

Pyynnön PUT tekstin tulee olla viivattuja.

DELETE

Poista QR-koodi

Poistaa QR-koodin.

Avaa GitBookissa

Polku: /product/{productId}

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

Pyydä lisätietoja

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 avaimelle API myönnetyt käyttöoikeudet.

Avaa GitBookissa

Polku: /permission

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

Pyydä lisätietoja

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ä luodessasi tai päivittäessäsi QR-tuotteita.

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

Aloita dynaamiset QR-koodit ja vaihdettavat QR-koodit kotisivullamme.