Dokumentácia API

Zdroje a príručky pre vývojárov pre integráciu QR Cake .

JSON REST APIDynamická tvorba QRBearer Autorizácia

Vytvoriť kľúč API

Rýchly štart

QR Cake API umožňuje QR Cake používateľom spravovať svoj účet QR Codes.

Základ URL

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

Koncové body

Zoznam QR CodesGET

/user/product

Získajte QR kódGET

/product/{productId}

Vytvorte QR kódPOST

/product

Aktualizujte QR kódPUT

/product/{productId}

Odstráňte QR kódDELETE

/product/{productId}

PovoleniaGET

/permission

Autentifikácia

Vytvorte kľúč API na informačnom paneli a odošlite ho v hlavičke Autorizácia.

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

Spravovať kľúče API Dashboard API Keys.

API Vyžiadať testera

Testujte koncové body priamo z tejto stránky. Zadajte svoj kľúč API, vyberte koncový bod a skontrolujte aktuálnu odpoveď.

Interaktívny tester API

Spúšťajte požiadavky priamo z prehliadača do vybratého koncového bodu QR Cake API.

GET

Koncový bod

Kľúč API

Authorization: Bearer <API Key>

Vyriešené URL

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

Spustite požiadavku, aby ste tu videli aktuálny stav a výstup odpovede.

Terminológia

Produkty

QR Codes

Používatelia

QR Cake účtov

Telá žiadostí (POST/PUT)

V prípade žiadostí POST a PUT musia byť telá žiadostí špecifikované. Ak odosielate JSON, odovzdajte reťazec JSON (napr JSON.stringify(payload)).

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

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

GET

Zoznam QR Codes

Uvádza zoznam QR Codes prístupných pre kľúč API.

Otvoriť v GitBook

Cesta: /user/product

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

Vyžiadajte si podrobnosti

Hlavičky

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

Odpovede

200 OK

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

401 Unauthorized

{
  "message": {}
}

Produkty = QR Codes.

GET

Získajte QR kód

Načíta jeden QR kód.

Otvoriť v GitBook

Cesta: /product/{productId}

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

Vyžiadajte si podrobnosti

Parametre cesty

productId (string)

Hlavičky

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

Odpovede

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Vytvorte QR kód

Vytvorí nový produkt QR Code.

Otvoriť v GitBook

Cesta: /product

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

Vyžiadajte si podrobnosti

Hlavičky

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

Šablóna tela

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

Odpovede

200 OK

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

401 Unauthorized

{
  "message": {}
}

Telo požiadavky POST musí byť spresnené (napríklad JSON.stringify(payload)).

PUT

Aktualizujte QR kód

Aktualizuje existujúci QR kód (produkt).

Otvoriť v GitBook

Cesta: /product/{productId}

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

Vyžiadajte si podrobnosti

Parametre cesty

productId (string)

Hlavičky

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

Šablóna tela

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

Odpovede

200 OK

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

401 Unauthorized

{
  "message": {}
}

PUT telo požiadavky musí byť špecifikované.

DELETE

Odstráňte QR kód

Odstráni QR kód.

Otvoriť v GitBook

Cesta: /product/{productId}

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

Vyžiadajte si podrobnosti

Parametre cesty

productId (string)

Hlavičky

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

Odpovede

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Povolenia

Vráti povolenia udelené kľúču API.

Otvoriť v GitBook

Cesta: /permission

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

Vyžiadajte si podrobnosti

Hlavičky

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

Odpovede

200 OK

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

401 Unauthorized

{
  "message": {}
}

Podporované typy QR

Tieto typy metadát použite pri vytváraní alebo aktualizácii produktov QR.

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

Začnite s dynamické QR kódy a vymeniteľné QR kódy na našej domovskej stránke.