Hızlı başlangıç
QR Cake API, QR Cake kullanıcılarının hesaplarındaki QR kodlarını yönetmelerini sağlar.
Kimlik doğrulama
Kontrol panelinizde bir API anahtarı oluşturun ve bunu x-api-key başlığında gönderin.
x-api-key: <API Key> Content-Type: application/json
API anahtarlarını şuradan yönetin: Kontrol paneli API anahtarları.
API istek 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.
x-api-key: YOUR_API_KEYhttps://api.qrcake.com/v1/product/api/product
Terminoloji
Ürünler
QR kodları
Kullanıcılar
QR Cake hesapları
İstek gövdeleri (POST/PUT)
POST ve PUT istekleri için istek gövdeleri dize haline getirilmelidir. 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),
});QR kodlarını listele
API anahtarının erişebildiği QR kodlarını listeler.
x-api-key: <API Key>Accept: application/json
[
{
"accountId": "string",
"productId": "string",
"userId": "string",
"redirect": "string",
"state": "ACTIVE",
"metadata": {},
"createdAt": 0,
"updatedAt": 0
}
]{
"message": {}
}Products = QR kodları.
Bir QR kodu getir
Bir QR kodunu getirir.
- productId (string)
x-api-key: <API Key>Accept: application/json
{
"accountId": "string",
"productId": "string",
"userId": "string",
"redirect": "string",
"state": "ACTIVE",
"metadata": {},
"createdAt": 0,
"updatedAt": 0
}{
"message": {}
}Bir QR kodu oluştur
Yeni bir QR kod ürünü oluşturur.
x-api-key: <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": {}
}POST istek gövdesi dize haline getirilmelidir (örneğin, JSON.stringify(payload)).
Bir QR kodunu güncelle
Mevcut bir QR kodunu (ürün) günceller.
- productId (string)
x-api-key: <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": {}
}PUT istek gövdesi dize haline getirilmelidir.
Bir QR kodunu sil
Bir QR kodunu siler.
- productId (string)
x-api-key: <API Key>Accept: application/json
{
"productId": "string"
}{
"message": {}
}İzinler
API anahtarına verilen izinleri döndürür.
x-api-key: <API Key>Accept: application/json
{
"success": true,
"result": {
"tier": "subscriber",
"active": true,
"analytics": true,
"productLimit": 100,
"productTotal": 3,
"productActiveLimit": 100,
"productActiveTotal": 3
}
}{
"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, review
Ana sayfamızdan dinamik QR kodlar ve değiştirilebilir QR kodlar ile başlayın.