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.
Türe göre QR kodu verileri
16 türün her biri için
data biçimi.Özelleştirme
Nokta stilleri, renkler, çerçeveler ve logolar.
Erişim kuralları
Zamanlama, tarama sınırı ve parola.
QR kodu nesnesi
Silme ve İndirme dışındaki her QR kodu uç noktası bu nesneyle yanıt verir. Listeleme bunların bir dizisini döndürür.string
QR kodunun benzersiz kimliği; örneğin
qr_1EPcVfeHZAY2iNoVLsgW2Aqf.string
QR kodu türü; örneğin
website. 16 değerin tamamı için bkz. Türe göre QR kodu verileri.string | null
Panelde gösterilen QR kodu adı.
string | null
QR kodu hakkında serbest metin not.
string
Saklanan veri yükü.
wifi, vcard, social, multilink, event ve sms için gönderdiğiniz veri yüküdür. Diğer tüm türlerde kısa bağlantıdır; bu nedenle hedefi url alanından okuyun.boolean
QR kodu duraklatıldığında
true.boolean
Panelde oluşturulmuş, kısa bağlantısı olmayan statik bir QR kodu için
true. API her zaman dinamik QR kodları oluşturur.string | null
Tam kısa bağlantı; örneğin
https://getqr.sh/x7Kd2p1.string | null
Kısa bağlantının alan adı.
string | null
Kısa bağlantının slug’ı.
boolean
Slug otomatik oluşturulmak yerine seçildiyse
true.string | null
Kısa bağlantının yönlendirdiği hedef.
string | null
app QR kodları için iOS ziyaretçilerinin hedefi.string | null
app QR kodları için Android ziyaretçilerinin hedefi.integer
Toplam tarama sayısı.
object
Erişim kuralları. Parolanın kendisi hiçbir zaman döndürülmez. Bkz. Erişim kuralları.
string
Salt okunur.
custom, API’nin tamamen düzenleyebildiği bir tasarımdır. branded ve ai, panelde oluşturulmuş bir markalı tasarım veya yapay zeka tasarımıdır. API bunun görselini düzenleyemez ancak diğer alanları değiştirdiğinizde görseli korur.object
Kayıtlı tasarım:
styles, frameOptions ve logoOptions; her biri bir nesne veya null. İstek alanlarıyla aynı yapıya sahiptirler; böylece geri gönderebilirsiniz. Bkz. Özelleştirme.object | null
Bir
pdf, image veya video QR kodunun dosyası: id, name ve bayt cinsinden size.string | null
Salt okunur. Panelde oluşturulmuş bir
app QR kodunun görünen adı.object | null
Salt okunur. Panelde oluşturulmuş, birden fazla dosya içeren bir
pdf QR kodu: title, layout ve files.object | null
Salt okunur. Panelde oluşturulmuş, birden fazla görsel içeren bir
image QR kodu: title, layout ve files.string
Oluşturulma tarihi, ISO 8601.
string
Son güncelleme tarihi, ISO 8601.
password, userId, workspaceId, projectId) hiçbir zaman döndürülmez.
QR kodlarını listeleme
GET /api/v1/qrs
Çalışma alanınızdaki QR kodlarını sayfa sayfa döndürür.
integer
varsayılan:"1"
Döndürülecek sayfa; 1 veya daha büyük.
integer
varsayılan:"100"
Sayfa başına QR kodu; 1 ile 100 arası. Daha büyük bir değer reddedilir.
string
QR kodunun başlığıyla eşleşir. 2 karakterden uzun sorgular saklanan
data ile de eşleşir. Bağlantı türlerinde saklanan data kısa bağlantıdır; bu nedenle hedef URL’ler aranamaz.string
varsayılan:"createdAt"
Sıralama alanı:
createdAt, updatedAt, clicks (toplam tarama), lastClicked (son tarama) veya type. type her zaman azalan sırada sıralar ve sortOrder değerini yok sayar.string
varsayılan:"desc"
Sıralama yönü:
asc veya desc.boolean
varsayılan:"false"
Duraklatılmış QR kodlarını dahil eder.
boolean
varsayılan:"false"
Yalnızca duraklatılmış QR kodlarını döndürür.
showArchived değerini geçersiz kılar.true veya false dizelerini alır. pagination.hasMore değeri true olduğu sürece sonraki sayfayı isteyin. Bkz. Sayfalama.
QR kodu oluşturma
POST /api/v1/qrs
Bir QR kodunu ve kısa bağlantısını birlikte oluşturur. Yeni QR koduyla birlikte 201 Created yanıtı verir.
string
Kendi yeniden deneme belirteciniz. İsteği 24 saat içinde aynı anahtarla tekrarlamak, ikinci bir QR kodu oluşturmak yerine ilk yanıtı döndürür. Bkz. Yeniden denemeler ve kopyalar.
string
gerekli
QR kodunun neyi kodladığı.
data alanının hangi biçimde olması gerektiğini de belirler. Şunlardan biri: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email, event.string
gerekli
Türün veri yükü;
qrType değerine göre kontrol edilir. Boş bir dize kontrolü atlar. Her türün biçimi Türe göre QR kodu verileri sayfasındadır.object
QR kodunun çözümlendiği kısa bağlantı. İsteğe bağlıdır: gönderilmezse
link.url, data değerini izler.string
Panelde gösterilen QR kodu adı. Baştaki ve sondaki boşluklar kırpılır; 1 ile 40 karakter arası. Gönderilmezse QR kodu başlıksız olur.
string
QR kodu hakkında serbest metin not. En fazla 280 karakter.
string
Eşleşen hedefle yüklenmiş bir
pdf, image veya video QR kodunun dosyası. vcard, social ve multilink için logo hedefiyle yüklenmiş isteğe bağlı bir profil görseli. event de bunu kabul eder, ancak sayfası kapak görselini data.fileId alanından okur. Diğer türler 422 alır. Önce dosyayı Dosyalar ile yükleyin. Bkz. QR kodlarında dosyalar.string
Tasarımı yeni QR koduna uygulanan şablon. Gönderdiğiniz tasarım alanları bunun üzerine birleştirilir. Markalı tasarım veya yapay zeka tasarımı içeren bir şablon
422 (art_template_unsupported) alır. Bilinmeyen veya başka bir çalışma alanına ait bir şablon 404 alır.object
Nokta ve köşe şekilleri ve renkleri. Bkz. Özelleştirme.
object
QR kodunun çevresine çizilen çerçeve ve harekete geçirici mesaj metni. Bkz. Özelleştirme.
object
Ortadaki logo: önerilen bir logo veya
logo hedefiyle yüklenmiş kendi dosyanız. Bilinmeyen bir dosya, tamamlanmamış bir yükleme veya başka bir hedefe ait bir dosya reddedilir. Bkz. Özelleştirme.object
Zamanlama, tarama sınırı ve parola koruması. Bkz. Erişim kuralları.
boolean
QR kodunun duraklatılmış olup olmadığı.
true, kodu duraklatılmış olarak oluşturur: taramalar hedef yerine duraklatma sayfasını gösterir.Yeniden denemeler ve kopyalar
- Anahtarla. Bir
Idempotency-Keybaşlığıyla yanıt 24 saat boyunca tekrarlanır. - Anahtarsız. 30 saniye içinde gönderilen aynı gövde kopya olarak değerlendirilir.
- Tekrarlar. Bir tekrar, saklanan yanıtı
x-idempotent-replay: trueile döndürür. Yeni bir QR kodufalsedöndürür. - İşlenirken. İlki hâlâ çalışırken gönderilen ikinci istek
409 conflictalır. - Başarısızlıklar. Başarısız bir oluşturma anahtarı hemen serbest bırakır; böylece aynı anahtarla yeniden deneyebilirsiniz.
- En iyi çaba. Koruma mekanizması kullanılamıyorsa oluşturma istekleri korumasız olarak işlenir.
QR kodunu alma
GET /api/v1/qrs/{qrId}
Bir QR kodunu kısa bağlantısı, erişim kuralları, tasarımı ve dosya tabanlı türler için dosyasıyla birlikte döndürür.
string
gerekli
Liste veya oluşturma yanıtından alınan QR kodu kimliği.
QR kodunu güncelleme
PATCH /api/v1/qrs/{qrId}
Bir QR kodunun içeriğini, hedefini, tasarımını veya erişim kurallarını değiştirir. Yalnızca değiştirmek istediğiniz alanları gönderin. Güncellenmiş QR koduyla yanıt verir.
string
gerekli
QR kodunun kimliği.
templateId. Kabul edilmez.link. Kısmidir.link.urlgöndermediğinizde mevcut hedef korunur.link.domainvelink.key422alır: basılı kodun kodladığı şey kısa bağlantıdır, bu yüzden farklı bir kısa bağlantı kullanmak için yeni bir QR kodu oluşturun.data. YalnızcadataveyaqrTypedeğiştiğinde sonuçtaki türe göre kontrol edilir. EşleşendataolmadanqrTypedeğiştirmek reddedilir. Bkz. Tür değiştirme.- Tasarım.
styles,frameOptionsvelogoOptionskayıtlı tasarımla birleştirilir; bu nedenle kısmi bir nesne yalnızca belirttiği şeyleri değiştirir. Başka bir logo seçmek logonun yerini alır ancak boyutunu korur. access. Her anahtar mevcut olduğunda uygulanır.nullbir kuralı temizler. Erişim kurallarıaccessaltına aittir: bunlarılinkaltında göndermek422alır.archived. Duraklatma ve Yeniden etkinleştirme gibi, QR kodunu ve kısa bağlantısını birlikte duraklatır veya yeniden etkinleştirir.
Duraklatma durumunu ayarlama
PUT /api/v1/qrs/{qrId}
Duraklatma durumunu doğrudan ayarlar. Duraklatma ve Yeniden etkinleştirme aynı işi yapar ve daha anlaşılırdır.
string
gerekli
QR kodunun kimliği.
boolean
gerekli
QR kodunu duraklatmak için
true, yeniden etkinleştirmek için false.QR kodunu duraklatma
POST /api/v1/qrs/{qrId}/pause
QR kodunun hedefine yönlendirmesini durdurur: taramalar bunun yerine duraklatma sayfasını gösterir. Basılı kod ve kısa bağlantısı geçerli kalır. İstek gövdesi yoktur.
string
gerekli
QR kodunun kimliği.
QR kodunu yeniden etkinleştirme
POST /api/v1/qrs/{qrId}/activate
Duraklatılmış bir QR kodunun yeniden hedefine yönlendirmesini sağlar. Varsa zamanlama ve tarama sınırı geçerli olmaya devam eder. İstek gövdesi yoktur.
string
gerekli
QR kodunun kimliği.
QR kodunu çoğaltma
POST /api/v1/qrs/{qrId}/duplicate
Aynı içerik ve tasarıma sahip bir kopya oluşturur. İstek gövdesi yoktur. Yeni QR koduyla birlikte 201 Created yanıtı verir.
string
gerekli
Kopyalanacak QR kodunun kimliği.
- Kısa bağlantı. Kopya, kaynağın alan adında değil, çalışma alanının varsayılan alan adında rastgele bir slug ile kendi kısa bağlantısını alır. Taramaları ayrı sayılır.
- Başlık. Başlığa
(Copy)soneki eklenir. Sonuç 40 karakteri aşmaz: uzun bir başlık önce kısaltılır. Başlıksız bir QR kodu başlıksız kalır. - Kopyalanmayanlar. Erişim kuralları (parola, zamanlama, tarama sınırı) ve duraklatma durumu. Kopya her zaman aktiftir.
- Dosyalar. Paket ve galeri dosyaları dahil PDF ve görsel dosyaları kopyalanır; böylece bunlar kopyaya ait olur. Video dosyaları ve logolar gibi tasarım dosyaları kaynakla paylaşılır.
QR kodunu silme
DELETE /api/v1/qrs/{qrId}
QR kodunu ve kısa bağlantısını siler. Silinen kimlikle yanıt verir.
string
gerekli
QR kodunun kimliği.
string
Silinen QR kodunun kimliği.
boolean
Her zaman
true.QR kodu görselini indirme
GET /api/v1/qrs/{qrId}/download
QR kodunu tasarımıyla birlikte oluşturur ve dosyayı döndürür.
string
gerekli
Liste veya oluşturma yanıtından alınan, oluşturulacak QR kodunun kimliği.
string
varsayılan:"jpg"
Çıktı biçimi:
jpg, png, svg, pdf (A4 sayfa) veya eps. Markalı tasarım veya yapay zeka tasarımı yalnızca jpg, png veya pdf olarak indirilir.integer
varsayılan:"1024"
Piksel cinsinden görsel boyutu:
1024, 2048 veya 4096. svg ve pdf bunu yok sayar. Markalı tasarım veya yapay zeka tasarımı yalnızca 1024 boyutunda indirilir.- Gövde. Yanıt gövdesi dosyanın kendisidir. Önerilen dosya adı
Content-Dispositionbaşlığındadır; başlıktan, başlıksız bir QR kodu içinseqr-codedeğerinden oluşturulur. - Önbellek. Yanıtlar bir
ETagveCache-Control: private, max-age=3600, must-revalidateiçerir. QR kodu değişmediğinde304 Not Modifiedalmak içinETagdeğeriniIf-None-Matchiçinde geri gönderin. - Hatalar. Desteklenmeyen bir biçim veya çözünürlük
400 bad_requestalır. Hata mesajı nedeni belirtir:qr_download_invalid_format,qr_download_invalid_resolution,qr_download_art_format_unsupportedveyaqr_download_art_resolution_unsupported.
Erişim kuralları
Bir başlangıç ve bitiş zamanlamak, tarama sayısını sınırlamak veya parola istemek için oluştururken ya da güncellerken biraccess nesnesi gönderin. Gönderilmeyen kurallar değişmeden kalır ve null bir kuralı temizler. Örneklerle birlikte tam davranış Erişim kuralları sayfasındadır.
Tasarım nesneleri
styles, frameOptions ve logoOptions; nokta ve köşe şekillerini, renkleri, çerçeveyi ve logoyu belirler. QR kodlarında, şablonlarda ve toplu oluşturmalarda aynı şekilde çalışırlar. Bilinmeyen şekiller, çerçeveler veya logolar reddedilir. Kabul edilen tüm değerler ve uygulamalı bir örnek Özelleştirme sayfasındadır.
Sık karşılaşılan sorunlar
Parola, zamanlama veya tarama sınırı ayarlarken 422
Parola, zamanlama veya tarama sınırı ayarlarken 422
Kuralı
link altında değil, access altında gönderin.link.domain veya link.key değiştirirken 422
link.domain veya link.key değiştirirken 422
Basılı kod kısa bağlantıyı kodladığı için kısa bağlantı oluşturulduktan sonra değiştirilemez. Bunun yerine yeni bir QR kodu oluşturun.
422 "Expected … for qrType"
422 "Expected … for qrType"
data, qrType biçimiyle eşleşmiyor. Türü Türe göre QR kodu verileri sayfasında kontrol edin.QR kodu oluştururken 409 conflict
QR kodu oluştururken 409 conflict
Aynı oluşturma isteği hâlâ çalışıyor veya
link.key alınmış. İlk istek tamamlandığında yeniden deneyin. Bir Idempotency-Key ile yeniden deneme ilk QR kodunu döndürür.İndirilen dosya PNG değil, JPEG
İndirilen dosya PNG değil, JPEG
Parametreler
format ve resolution şeklindedir ve format varsayılan olarak jpg olur. format=png gönderin.Panelde gördüğüm bir QR kodu için 404
Panelde gördüğüm bir QR kodu için 404
Her istek, API anahtarınızın çalışma alanında çalışır. QR kodunun bu çalışma alanına ait olduğunu kontrol edin. Bkz. Kimlik doğrulama.