Dokumentacija API-ja

Razvijalski viri in vodniki za integracijo QR Cake .

JSON REST APIDinamično ustvarjanje QRBearer Pooblastilo

Ustvari ključ API

Hitri začetek

QR Cake API omogoča QR Cake uporabnikom, da upravljajo svoj račun QR Codes.

Osnova URL

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

Končne točke

Seznam QR CodesGET

/user/product

Pridobite kodo QRGET

/product/{productId}

Ustvari kodo QRPOST

/product

Posodobite kodo QRPUT

/product/{productId}

Izbrišite kodo QRDELETE

/product/{productId}

DovoljenjaGET

/permission

Preverjanje pristnosti

Ustvarite ključ API na svoji nadzorni plošči in ga pošljite v glavi avtorizacije.

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

Upravljanje API ključev Nadzorna plošča API Tipke.

API Zahtevaj testerja

Preizkusite končne točke neposredno s te strani. Vnesite ključ API, izberite končno točko in preglejte odziv v živo.

Interaktivni API tester

Zaženite zahteve neposredno iz vašega brskalnika do izbrane končne točke QR Cake API.

GET

Končna točka

API Ključ

Authorization: Bearer <API Key>

Razrešeno URL

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

Tukaj zaženite zahtevo za ogled stanja v živo in odgovora.

Terminologija

Izdelki

QR Codes

Uporabniki

QR Cake računov

Tela zahteve (POST/PUT)

Za zahteve POST in PUT morajo biti telesa zahtev nizirana. Če pošiljate JSON, posredujte niz JSON (npr JSON.stringify(payload)).

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

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

GET

Seznam QR Codes

Navede QR Codes, ki je dostopen s ključem API.

Odpri v GitBooku

Pot: /user/product

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

Podrobnosti zahteve

Glave

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

Odzivi

200 OK

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

401 Unauthorized

{
  "message": {}
}

Izdelki = QR Codes.

GET

Pridobite kodo QR

Pridobi eno kodo QR.

Odpri v GitBooku

Pot: /product/{productId}

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

Podrobnosti zahteve

Parametri poti

productId (string)

Glave

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

Odzivi

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Ustvari kodo QR

Ustvari nov izdelek s kodo QR.

Odpri v GitBooku

Pot: /product

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

Podrobnosti zahteve

Glave

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

Šablona telesa

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

Odzivi

200 OK

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

401 Unauthorized

{
  "message": {}
}

Telo zahteve POST mora biti v nizu (na primer JSON.stringify(payload)).

PUT

Posodobite kodo QR

Posodobi obstoječo kodo QR (izdelek).

Odpri v GitBooku

Pot: /product/{productId}

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

Podrobnosti zahteve

Parametri poti

productId (string)

Glave

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

Šablona telesa

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

Odzivi

200 OK

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

401 Unauthorized

{
  "message": {}
}

Telo zahteve PUT mora biti v nizu.

DELETE

Izbrišite kodo QR

Izbriše kodo QR.

Odpri v GitBooku

Pot: /product/{productId}

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

Podrobnosti zahteve

Parametri poti

productId (string)

Glave

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

Odzivi

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Dovoljenja

Vrne dovoljenja, dodeljena ključu API.

Odpri v GitBooku

Pot: /permission

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

Podrobnosti zahteve

Glave

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

Odzivi

200 OK

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

401 Unauthorized

{
  "message": {}
}

Podprte vrste QR

Uporabite te vrste metapodatkov, ko ustvarjate ali posodabljate izdelke QR.

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

Začnite z dinamične QR kode in spremenljive QR kode na naši domači strani.