API Belgeleri

    QR Cake entegrasyonu için geliştirici kaynakları ve rehberler.

    JSON REST APIDinamik QR OluşturmaBearer Yetkilendirme

    Hızlı Başlangıç

    QR Cake API, QR Cake kullanıcılarının hesaplarındaki QR kodlarını yönetmelerini sağlar.

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

    Kimlik doğrulama

    Panelinizden bir API anahtarı oluşturun ve bunu Authorization başlığında gönderin.

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

    API anahtarlarını burada yönetin Panel API Anahtarları.

    API İstek Test Aracı

    Uç noktaları doğrudan bu sayfadan test edin. API anahtarınızı girin, bir uç nokta seçin ve canlı yanıtı inceleyin.

    Etkileşimli API Test Aracı

    İstekleri doğrudan tarayıcınızdan seçilen QR Cake API uç noktasına çalıştırın.

    GET
    Authorization: Bearer <API Key>
    Çözümlenen URL
    https://api.qrcake.com/v1/product/user/product
    Canlı durumu ve yanıt çıktısını burada görmek için bir istek çalıştırın.

    Terminoloji

    Ürünler

    QR kodları

    Kullanıcılar

    QR Cake hesapları

    İstek Gövdeleri (POST/PUT)

    POST ve PUT istekleri için istek gövdelerinin dizeleştirilmesi gerekir. JSON gönderiyorsanız bir JSON dizesi iletin (örneğin JSON.stringify(payload)).

    const payload = { redirect: "https://example.com", metadata: {} };
    
    await fetch(url, {
      method: "POST",
      body: JSON.stringify(payload),
    });
    GET

    QR kodlarını listele

    API anahtarının erişebildiği QR kodlarını listeler.

    GitBook'ta aç
    Yol: /user/product
    URL: https://api.qrcake.com/v1/product/user/product
    Ayrıntıları Talep Et
    Başlıklar
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Yanıtlar
    200 OK
    [
      {
        "accountId": "string",
        "productId": "string",
        "userId": "string",
        "redirect": "string",
        "state": "ACTIVE",
        "metadata": {},
        "createdAt": 0,
        "updatedAt": 0
      }
    ]
    401 Unauthorized
    {
      "message": {}
    }

    Products = QR kodları.

    GET

    Bir QR kodu getir

    Bir QR Kodu getirir.

    GitBook'ta aç
    Yol: /product/{productId}
    URL: https://api.qrcake.com/v1/product/product/{productId}
    Ayrıntıları Talep Et
    Yol parametreleri
    • productId (string)
    Başlıklar
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Yanıtlar
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }
    POST

    Bir QR kodu oluştur

    Yeni bir QR kod ürünü oluşturur.

    GitBook'ta aç
    Yol: /product
    URL: https://api.qrcake.com/v1/product/product
    Ayrıntıları Talep Et
    Başlıklar
    • Authorization: Bearer <API Key>
    • Content-Type: application/json
    • Accept: application/json
    Gövde şablonu
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    Yanıtlar
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }

    POST istek gövdesi dizelendirilmelidir (örneğin, JSON.stringify(payload)).

    PUT

    Bir QR kodunu güncelle

    Mevcut bir QR Kodunu (ürün) günceller.

    GitBook'ta aç
    Yol: /product/{productId}
    URL: https://api.qrcake.com/v1/product/product/{productId}
    Ayrıntıları Talep Et
    Yol parametreleri
    • productId (string)
    Başlıklar
    • Authorization: Bearer <API Key>
    • Content-Type: application/json
    • Accept: application/json
    Gövde şablonu
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    Yanıtlar
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "expiresAt": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
    401 Unauthorized
    {
      "message": {}
    }

    PUT istek gövdesi dizelendirilmelidir.

    DELETE

    Bir QR kodunu sil

    Bir QR Kodunu siler.

    GitBook'ta aç
    Yol: /product/{productId}
    URL: https://api.qrcake.com/v1/product/product/{productId}
    Ayrıntıları Talep Et
    Yol parametreleri
    • productId (string)
    Başlıklar
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Yanıtlar
    200 OK
    {
      "productId": "string"
    }
    401 Unauthorized
    {
      "message": {}
    }
    GET

    İzinler

    API anahtarına verilen izinleri döndürür.

    GitBook'ta aç
    Yol: /permission
    URL: https://api.qrcake.com/v1/product/permission
    Ayrıntıları Talep Et
    Başlıklar
    • Authorization: Bearer <API Key>
    • Accept: application/json
    Yanıtlar
    200 OK
    {
      "success": true,
      "result": {
        "analytics": true,
        "productLimit": 100,
        "tier": "subscriber",
        "productTotal": 3,
        "productActiveLimit": 100,
        "productActiveTotal": 3
      }
    }
    401 Unauthorized
    {
      "message": {}
    }

    Desteklenen QR Türleri

    QR ürünlerini oluştururken veya güncellerken bu meta veri türlerini kullanın.

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

    Ana sayfamızdan dinamik QR kodlar ve düzenlenebilir QR kodlar ile başlayın.