API dokumendid

Arendaja ressursid ja juhendid QR Cake integreerimiseks.

JSON REST APIDünaamiline QR-i loomineBearer Autoriseerimine

Loo võti API

Kiire algus

QR Cake API võimaldab QR Cake kasutajatel hallata oma kontot QR Codes.

Baas URL

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

Lõpp-punktid

Loend QR CodesGET

/user/product

Hankige QR-koodGET

/product/{productId}

Looge QR-koodPOST

/product

Värskendage QR-koodiPUT

/product/{productId}

Kustutage QR-koodDELETE

/product/{productId}

loadGET

/permission

Autentimine

Looge oma armatuurlaual võti API ja saatke see autoriseerimispäisesse.

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

Hallake API võtmeid Armatuurlaud API Klahvid.

API Taotle testijat

Testige lõpp-punkte otse sellelt lehelt. Sisestage oma võti API, valige lõpp-punkt ja kontrollige reaalajas vastust.

Interaktiivne API testija

Käivitage päringuid otse oma brauserist valitud QR Cake API lõpp-punkti.

GET

Lõpp-punkt

API Võti

Authorization: Bearer <API Key>

Lahendatud URL

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

Käivitage taotlus, et näha siin reaalajas olekut ja vastuseväljundit.

Terminoloogia

Tooted

QR Codes

Kasutajad

QR Cake kontot

Taotluse organid (POST/PUT)

POST ja PUT taotluste puhul peavad päringu kehad olema stringitud. Kui saadate JSON-i, edastage JSON-string (näiteks JSON.stringify(payload)).

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

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

GET

Loend QR Codes

Loetleb QR Codes, millele pääseb juurde klahvi API jaoks.

Avage GitBookis

Tee: /user/product

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

Taotlege üksikasju

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

Tooted = QR Codes.

GET

Hankige QR-kood

Toob ühe QR-koodi.

Avage GitBookis

Tee: /product/{productId}

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

Taotlege üksikasju

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

Looge QR-kood

Loob uue QR-koodi toote.

Avage GitBookis

Tee: /product

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

Taotlege üksikasju

Päised

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

Keha 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 keha peab olema stringitud (näiteks JSON.stringify(payload)).

PUT

Värskendage QR-koodi

Värskendab olemasolevat QR-koodi (toodet).

Avage GitBookis

Tee: /product/{productId}

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

Taotlege üksikasju

Tee parameetrid

productId (string)

Päised

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

Keha 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 stringitud.

DELETE

Kustutage QR-kood

Kustutab QR-koodi.

Avage GitBookis

Tee: /product/{productId}

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

Taotlege üksikasju

Tee parameetrid

productId (string)

Päised

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

Vastused

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

load

Tagastab võtmele API antud õigused.

Avage GitBookis

Tee: /permission

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

Taotlege üksikasju

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

Kasutage neid metaandmete tüüpe QR-toodete loomisel või värskendamisel.

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

Alustage dünaamilised QR-koodid ja vahetatavad QR-koodid meie avalehel.