API dokumenti
Resursi i vodiči za razvojne programere za integraciju QR Cake .
Brzi početak
QR Cake API omogućuje QR Cake korisnicima da upravljaju svojim računom QR Codes.
Autentifikacija
Izradite ključ API na svojoj nadzornoj ploči i pošaljite ga u zaglavlju Autorizacija.
Authorization: Bearer <API Key> Content-Type: application/json
Upravljanje API ključevima Nadzorna ploča API Tipke.
API Zatraži tester
Testirajte krajnje točke izravno s ove stranice. Unesite svoj ključ API, odaberite krajnju točku i pregledajte odgovor uživo.
Interaktivni API tester
Pokreni zahtjeve izravno iz svog preglednika na odabranu krajnju točku QR Cake API.
Authorization: Bearer <API Key>https://api.qrcake.com/v1/product/user/product
Terminologija
Proizvodi
QR Codes
Korisnici
QR Cake računa
Tijela zahtjeva (POST/PUT)
Za zahtjeve POST i PUT tijela zahtjeva moraju biti stringirana. Ako šaljete JSON, proslijedite JSON niz (na primjer JSON.stringify(payload)).
const payload = { redirect: "https://example.com", metadata: {} };
await fetch(url, {
method: "POST",
body: JSON.stringify(payload),
});Popis QR Codes
Navodi QR Codes dostupno ključu API.
Authorization: Bearer <API Key>Accept: application/json
[
{
"accountId": "string",
"productId": "string",
"userId": "string",
"redirect": "string",
"state": "ACTIVE",
"metadata": {},
"createdAt": 0,
"updatedAt": 0
}
]{
"message": {}
}Proizvodi = QR Codes.
Nabavite QR kod
Dohvaća jedan QR kod.
- productId (string)
Authorization: Bearer <API Key>Accept: application/json
{
"accountId": "string",
"productId": "string",
"userId": "string",
"redirect": "string",
"state": "ACTIVE",
"metadata": {},
"createdAt": 0,
"updatedAt": 0
}{
"message": {}
}Stvorite QR kod
Stvara novi proizvod s QR kodom.
Authorization: Bearer <API Key>Content-Type: application/jsonAccept: application/json
{
"redirect": "https://example.com",
"metadata": {},
"state": "ACTIVE"
}{
"accountId": "string",
"productId": "string",
"userId": "string",
"redirect": "string",
"state": "ACTIVE",
"metadata": {},
"createdAt": 0,
"updatedAt": 0
}{
"message": {}
}Tijelo zahtjeva POST mora biti stringificirano (na primjer, JSON.stringify(payload)).
Ažurirajte QR kod
Ažurira postojeći QR kod (proizvod).
- productId (string)
Authorization: Bearer <API Key>Content-Type: application/jsonAccept: application/json
{
"redirect": "https://example.com",
"metadata": {},
"state": "ACTIVE"
}{
"accountId": "string",
"productId": "string",
"userId": "string",
"redirect": "string",
"state": "ACTIVE",
"metadata": {},
"expiresAt": 0,
"createdAt": 0,
"updatedAt": 0
}{
"message": {}
}Tijelo zahtjeva PUT mora biti stringificirano.
Brisanje QR koda
Briše QR kod.
- productId (string)
Authorization: Bearer <API Key>Accept: application/json
{
"productId": "string"
}{
"message": {}
}Dozvole
Vraća dopuštenja dodijeljena ključu API.
Authorization: Bearer <API Key>Accept: application/json
{
"success": true,
"result": {
"analytics": true,
"productLimit": 100,
"tier": "subscriber",
"productTotal": 3,
"productActiveLimit": 100,
"productActiveTotal": 3
}
}{
"message": {}
}Podržane vrste QR-a
Koristite ove vrste metapodataka prilikom izrade ili ažuriranja QR proizvoda.
redirect, link, image, video, file, pdf, audio, app, event, vCard
Započnite s dinamički QR kodovi i promjenjivi QR kodovi na našoj početnoj stranici.