API dokumenti

    Resursi i vodiči za razvojne programere za integraciju QR Cake .

    JSON REST APIDinamičko stvaranje QR-aBearer Autorizacija

    Brzi početak

    QR Cake API omogućuje QR Cake korisnicima da upravljaju svojim računom QR Codes.

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

    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.

    GET
    Authorization: Bearer <API Key>
    Riješeno URL
    https://api.qrcake.com/v1/product/user/product
    Pokrenite zahtjev da biste vidjeli status uživo i izlaz odgovora ovdje.

    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),
    });
    GET

    Popis QR Codes

    Navodi QR Codes dostupno ključu API.

    Otvorite u GitBooku
    Put: /user/product
    URL: https://api.qrcake.com/v1/product/user/product
    Detalji zahtjeva
    Zaglavlja
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Odgovori
    200 OK
    [
      {
        "accountId": "string",
        "productId": "string",
        "userId": "string",
        "redirect": "string",
        "state": "ACTIVE",
        "metadata": {},
        "createdAt": 0,
        "updatedAt": 0
      }
    ]
    401 Unauthorized
    {
      "message": {}
    }

    Proizvodi = QR Codes.

    GET

    Nabavite QR kod

    Dohvaća jedan QR kod.

    Otvorite u GitBooku
    Put: /product/{productId}
    URL: https://api.qrcake.com/v1/product/product/{productId}
    Detalji zahtjeva
    Parametri putanje
    • productId (string)
    Zaglavlja
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Odgovori
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }
    POST

    Stvorite QR kod

    Stvara novi proizvod s QR kodom.

    Otvorite u GitBooku
    Put: /product
    URL: https://api.qrcake.com/v1/product/product
    Detalji zahtjeva
    Zaglavlja
    • Authorization: Bearer <API Key>
    • Content-Type: application/json
    • Accept: application/json
    Šablona tijela
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    Odgovori
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }

    Tijelo zahtjeva POST mora biti stringificirano (na primjer, JSON.stringify(payload)).

    PUT

    Ažurirajte QR kod

    Ažurira postojeći QR kod (proizvod).

    Otvorite u GitBooku
    Put: /product/{productId}
    URL: https://api.qrcake.com/v1/product/product/{productId}
    Detalji zahtjeva
    Parametri putanje
    • productId (string)
    Zaglavlja
    • Authorization: Bearer <API Key>
    • Content-Type: application/json
    • Accept: application/json
    Šablona tijela
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    Odgovori
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "expiresAt": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }

    Tijelo zahtjeva PUT mora biti stringificirano.

    DELETE

    Brisanje QR koda

    Briše QR kod.

    Otvorite u GitBooku
    Put: /product/{productId}
    URL: https://api.qrcake.com/v1/product/product/{productId}
    Detalji zahtjeva
    Parametri putanje
    • productId (string)
    Zaglavlja
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Odgovori
    200 OK
    {
      "productId": "string"
    }
    401 Unauthorized
    {
      "message": {}
    }
    GET

    Dozvole

    Vraća dopuštenja dodijeljena ključu API.

    Otvorite u GitBooku
    Put: /permission
    URL: https://api.qrcake.com/v1/product/permission
    Detalji zahtjeva
    Zaglavlja
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Odgovori
    200 OK
    {
      "success": true,
      "result": {
        "analytics": true,
        "productLimit": 100,
        "tier": "subscriber",
        "productTotal": 3,
        "productActiveLimit": 100,
        "productActiveTotal": 3
      }
    }
    401 Unauthorized
    {
      "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.