Ana içeriğe atla
GetQR API’si beta aşamasındadır ve seçili çalışma alanlarında kullanılabilir. Ayrıntılar genel sürümden önce değişebilir.
Bir QR kodunun ne zaman çözümleneceğini, kaç kez taranabileceğini, parola isteyip istemeyeceğini ve duraklatılmış ya da silinmiş olup olmadığını kontrol edin.

Başlamadan önce

  • Rol. Kural belirlemek, duraklatmak, yeniden etkinleştirmek ve silmek için çalışma alanındaki QR kodlarına yazma erişimi gerekir. Bkz. Kimlik doğrulama.
  • Abonelik. Bunlar dahil her API isteği, çalışma alanı sahibinin aktif bir aboneliğini gerektirir.

Erişim nesnesi

Bir QR kodunu oluştururken veya güncellerken bir access nesnesi gönderin:
Göndermediğiniz alanlar değişmeden kalır. Bir kuralı temizlemek için null gönderin. Kısmi bir access nesnesi, belirtmediğiniz kuralları hiçbir zaman sıfırlamaz.
Erişim kuralları access altına aittir. activeAt, pauseAt, scanLimit, password veya passwordProtected alanlarını link altında göndermek 422 döndürür.

Başlangıç ve bitiş zamanlayın

activeAt ve pauseAt birbirinden bağımsızdır: birini veya ikisini birden ayarlayın. Her ikisi de Z veya bir UTC farkı içeren ISO 8601 tarih-saat değerleri alır.
Zamanlamayı temizlemek için null gönderin. Bu, QR kodunu hemen aktif hâle getirir ve bitiş tarihini kaldırır:

Tarama sınırı

Toplam tarama sayısını sınırlayın. Sınıra ulaşıldıktan sonra QR kodu çözümlenmeyi durdurur:
Ömür boyu tarama sayacı, sınır ayarlanmış olsun ya da olmasın her zaman çalışır. Bu, sınırı değiştirmenin sonucunu öngörülebilir kılar:
  • Sınırı yükseltmek, tam olarak (yeni sınır eksi toplam tarama) kadar ek tarama açar.
  • Sınırı mevcut toplamın altına düşürmek, QR kodunu hemen engeller.
  • Sınırı sonradan ayarlamak, sınır yokken yapılan taramaları da sayar.
scanLimit, en fazla 2147483647 olan pozitif bir tam sayı olmalıdır. Sınırsız için null gönderin.

Parola koruması

Parolayı aynı access nesnesiyle ayarlayın. Korumayı kapattığınızda kayıtlı parola saklanır; böylece parolayı yeniden göndermeden korumayı tekrar açabilirsiniz.
1

Parolayı ayarlayın veya değiştirin

Bu, korumayı da açar.
2

Korumayı kapatın

Kayıtlı parola saklanır.
3

Korumayı yeniden açın

Parolayı yeniden göndermeniz gerekmez. Bu yalnızca daha önce bir parola ayarlanmışsa çalışır. Aksi hâlde istek 422 alır.
  • Oluştururken. Korumayı açmak için password gönderin. Tek başına passwordProtected, bir parola olana kadar etkisizdir.
  • Parolayı kaldırma. "password": null gönderin. Koruma da kapanır.
  • Okuma. Yanıtlar parolayı hiçbir zaman döndürmez, yalnızca access.passwordProtected döndürür.

Duraklatma, yeniden etkinleştirme ve silme

Duraklatma ve yeniden etkinleştirme, access alanları değil ayrı uç noktalardır; çünkü bir zamanlamaya göre değil, anında etkili olurlar. Duraklatma ve etkinleştirme istek gövdesi almaz ve güncellenmiş QR kodunu döndürür:
Duraklatma durumunu PUT /api/v1/qrs/{qrId} ve { "archived": true } ile ya da bir PATCH içinde archived ile de ayarlayabilirsiniz. Bkz. Duraklatma durumunu ayarlama. Silme işlemi QR kodunu ve kısa bağlantısını birlikte kaldırır:
Silme işlemi geri alınamaz. Kısa bağlantı çözümlenmeyi durdurur, bu nedenle basılı kodlar çalışmaz hâle gelir. QR koduna yeniden ihtiyaç duyabilecekseniz silmek yerine duraklatın.

Değişiklikler ne zaman geçerli olur

  • Sonraki tarama. Kurallar bir kod tarandığında kontrol edilir; bu nedenle bir değişiklik geriye dönük değil, sonraki taramadan itibaren uygulanır.
  • Duraklatma sayfası. Bir zamanlama, tarama sınırı veya duraklatma nedeniyle engellenen QR kodu duraklatma sayfasını gösterir. Tarama yönlendirilmez.
  • Parola. Parolayı zaten girmiş olan ziyaretçiler, parola değişene veya koruma kapatılıp yeniden açılana kadar erişimini korur.
  • Saat. Zamanlamalar ziyaretçinin yerel saatini değil, UTC’deki sunucu saatini kullanır.
  • Kurallar birleşir. Bir QR kodu yalnızca duraklatılmamışsa, zamanlaması içindeyse ve tarama sınırının altındaysa çözümlenir.

Sık karşılaşılan sorunlar

QR kodunun henüz bir parolası yok. passwordProtected: true yerine password gönderin.
Bir zamanlama veya tarama sınırı hâlâ geçerli. QR kodundaki access.activeAt, access.pauseAt ve access.scanLimit değerlerini kontrol edin ve scans değerini sınırla karşılaştırın.
link.expiresAt bu API’de kullanılamaz. Bunun yerine access.pauseAt kullanın.

Sırada ne var

QR kodları

Türe göre QR kodu verileri