Dinamisko QR kodu API dokumentācija | QR Cake

Izveidojiet, atjauniniet un pārvaldiet dinamiskos QR kodus ar QR Cake API. Izmantojiet API atslēgas, testējiet pieprasījumus un savienojiet QR darbplūsmas ar saviem rīkiem.

JSON REST APIDinamisku QR kodu izveideAPI atslēgas autentifikācija

Ātrais sākums

QR Cake API ļauj QR Cake lietotājiem pārvaldīt sava konta QR kodus.

Bāzes URL

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

Galapunkti

Uzskaitīt QR kodusGET

/product

Iegūt QR koduGET

/product/{productId}

Izveidot QR koduPOST

/product

Atjaunināt QR koduPUT

/product/{productId}

Dzēst QR koduDELETE

/product/{productId}

AtļaujasGET

/permission

Autentifikācija

Izveidojiet API atslēgu savā informācijas panelī un nosūtiet to x-api-key galvenē.

x-api-key: <API Key>
Content-Type: application/json

API atslēgas pārvaldiet šeit: Informācijas paneļa API atslēgas.

API pieprasījumu testētājs

Testējiet galapunktus tieši šajā lapā. Ievadiet savu API atslēgu, atlasiet galapunktu un apskatiet reāllaika atbildi.

Interaktīvs API testētājs

Izpildiet pieprasījumus tieši no pārlūkprogrammas uz atlasīto QR Cake API galapunktu.

GET

Galapunkts

API atslēga

x-api-key: YOUR_API_KEY

Galīgais URL

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

Izpildiet pieprasījumu, lai šeit redzētu reāllaika statusu un atbildes izvadi.

Terminoloģija

Produkti

QR kodi

Lietotāji

QR Cake konti

Pieprasījuma pamatteksti (POST/PUT)

POST un PUT pieprasījumiem pieprasījuma pamatteksts jānodod kā virkne (stringified). Ja sūtāt JSON, nododiet to kā JSON virkni (piemēram, JSON.stringify(payload)).

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

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

GET

Uzskaitīt QR kodus

Uzskaita API atslēgai pieejamos QR kodus.

Atvērt GitBook

Ceļš: /product

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

Pieprasījuma detaļas

Galvenes

x-api-key: <API Key>
Accept: application/json

Atbildes

200 OK

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

401 Unauthorized

{
  "message": {}
}

Produkti = QR kodi.

GET

Iegūt QR kodu

Atgriež vienu QR kodu.

Atvērt GitBook

Ceļš: /product/{productId}

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

Pieprasījuma detaļas

Ceļa parametri

productId (string)

Galvenes

x-api-key: <API Key>
Accept: application/json

Atbildes

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Izveidot QR kodu

Izveido jaunu QR koda produktu.

Atvērt GitBook

Ceļš: /product

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

Pieprasījuma detaļas

Galvenes

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

Pamatteksta veidne

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

Atbildes

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST pieprasījuma pamatteksts jānodod kā virkne (piemēram, JSON.stringify(payload)).

PUT

Atjaunināt QR kodu

Atjaunina esošu QR kodu (produktu).

Atvērt GitBook

Ceļš: /product/{productId}

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

Pieprasījuma detaļas

Ceļa parametri

productId (string)

Galvenes

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

Pamatteksta veidne

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

Atbildes

200 OK

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

401 Unauthorized

{
  "message": {}
}

PUT pieprasījuma pamatteksts jānodod kā virkne.

DELETE

Dzēst QR kodu

Dzēš QR kodu.

Atvērt GitBook

Ceļš: /product/{productId}

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

Pieprasījuma detaļas

Ceļa parametri

productId (string)

Galvenes

x-api-key: <API Key>
Accept: application/json

Atbildes

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Atļaujas

Atgriež API atslēgai piešķirtās atļaujas.

Atvērt GitBook

Ceļš: /permission

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

Pieprasījuma detaļas

Galvenes

x-api-key: <API Key>
Accept: application/json

Atbildes

200 OK

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

401 Unauthorized

{
  "message": {}
}

Atbalstītie QR veidi

Izmantojiet šos metadatu veidus, veidojot vai atjauninot QR produktus.

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

Sāciet ar dinamiskajiem QR kodiem un maināmajiem QR kodiem mūsu mājaslapā.