API dokumentatsioon

Arendaja ressursid ja juhendid QR Cake integreerimiseks.

JSON REST APIDünaamiline QR-loomineBearer-autentimine

Kiire algus

QR Cake API võimaldab QR Cake kasutajatel hallata oma QR-koode programmiliselt.

Baas-URL

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

Lõpp-punktid

/user/product

/product/{productId}

/product

/product/{productId}

Kustuta QR-koodDELETE

/product/{productId}

ÕigusedGET

/permission

Autentimine

Loo oma juhtpaneelilt API võti ja saada see autoriseerimispäises.

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

Halda API võtmeid Juhtpaneeli API võtmed.

API päringute testija

Testi lõpp-punkte otse sellelt lehelt. Sisesta oma API võti, vali lõpp-punkt ja vaata vastust.

Interaktiivne API testija

Saada päringuid otse brauserist valitud QR Cake API lõpp-punktile.

GET

Lõpp-punkt

API võti

Authorization: Bearer YOUR_API_KEY

Lahendatud URL

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

Saada päring, et näha siin olekut ja vastuse sisu.

Terminoloogia

Products (tooted)

QR-koodid

Users (kasutajad)

QR Cake kontod

Päringu sisu (POST/PUT)

POST- ja PUT-päringute puhul peab päringu sisu olema string. Kui saadad JSON-i, edasta JSON-string (näiteks JSON.stringify(payload)).

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

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

GET

Loetle QR-koode

Loetleb QR-koodid, millele API võti pääseb ligi.

Ava GitBookis

Tee: /user/product

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

Päringu üksikasjad

Päised

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

Vastused

200 OK

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

401 Unauthorized

{
  "message": {}
}

Products = QR-koodid.

GET

Hangi QR-kood

Toob ühe QR-koodi.

Ava GitBookis

Tee: /product/{productId}

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

Päringu üksikasjad

Tee parameetrid

productId (string)

Päised

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

Vastused

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Loo QR-kood

Loob uue QR-koodi.

Ava GitBookis

Tee: /product

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

Päringu üksikasjad

Päised

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

Sisu mall

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

Vastused

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST päringu sisu peab olema string (näiteks JSON.stringify(payload)).

PUT

Uuenda QR-koodi

Uuendab olemasolevat QR-koodi.

Ava GitBookis

Tee: /product/{productId}

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

Päringu üksikasjad

Tee parameetrid

productId (string)

Päised

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

Sisu mall

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

Vastused

200 OK

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

401 Unauthorized

{
  "message": {}
}

PUT päringu sisu peab olema string.

DELETE

Kustuta QR-kood

Kustutab QR-koodi.

Ava GitBookis

Tee: /product/{productId}

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

Päringu üksikasjad

Tee parameetrid

productId (string)

Päised

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

Vastused

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Õigused

Tagastab API võtmele antud õigused.

Ava GitBookis

Tee: /permission

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

Päringu üksikasjad

Päised

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

Vastused

200 OK

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

401 Unauthorized

{
  "message": {}
}

Toetatud QR-tüübid

Kasuta neid metaandmete tüüpe QR-koodide loomisel või uuendamisel.

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

Alusta avalehel dünaamiliste QR-koodidega või muudetavate QR-koodidega.