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.
styles, frameOptions ve logoOptions. Hiçbir zaman içerik veya bağlantı taşımaz. Şablonlar çalışma alanındaki herkesle paylaşılır.
Şablon uygulayın
QR kodu oluştururkentemplateId gönderin. Şablonun tasarımı yeni QR koduna uygulanır. Aynı istekte gönderdiğiniz üç tasarım nesnesinden herhangi biri bunun üzerine birleştirilir.
- Bağlanmaz, kopyalanır. QR kodu tasarımın kendi kopyasını saklar. Şablonu daha sonra düzenlemek veya silmek onu değiştirmez.
- Yalnızca özel tasarımlar.
designKinddeğeribrandedveyaaiolan bir şablon API üzerinden uygulanamaz ve422(art_template_unsupported) döndürür. - Yalnızca çalışma alanınız. Bilinmeyen veya başka bir çalışma alanına ait bir şablon
404döndürür.
Başlıklar
string
gerekli
Bearer ve ardından API anahtarınız. Bkz. Kimlik doğrulama.string
application/json. Gövdesi olan isteklerde zorunludur.Şablon nesnesi
string
Şablonun kimliği; örneğin
qrt_8Hs2mQvKpLd4RtYw.string
Şablon seçilirken gösterilen ad.
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: görseli API üzerinden düzenlenemez ve diğer tasarım alanlarını değiştirdiğinizde korunur.object
Kayıtlı tasarım. Her alan, aynı adlı istek alanıyla aynı yapıya sahiptir; böylece tasarımı geri gönderebilirsiniz.
string
Oluşturulma tarihi, ISO 8601.
string
Son güncelleme tarihi, ISO 8601.
Şablonları listeleme
GET /api/v1/templates
Çalışma alanınızın şablonlarını en yeniden başlayarak döndürür. Liste sayfalıdır: bkz. Sayfalama.
integer
varsayılan:"1"
Döndürülecek sayfa; 1 veya daha büyük.
integer
varsayılan:"100"
Sayfa başına sonuç; 1 ile 100 arası.
Şablon oluşturma
POST /api/v1/templates
Yeni bir tasarım kaydeder. 201 Created ile yanıt verir. Tasarım alanları Özelleştirme sayfasındaki kataloglara göre kontrol edilir; bu nedenle bilinmeyen bir şekil, çerçeve veya logo 422 ile reddedilir.
string
gerekli
Şablon seçilirken gösterilen ad; 1 ile 40 karakter arası.
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
Ortaya yerleştirilen logo: önerilen bir logo veya Dosyalar uç noktasının
logo hedefiyle yüklenmiş kendi dosyanız. Bkz. Özelleştirme.Şablon alma
GET /api/v1/templates/{templateId}
string
gerekli
Şablonun kimliği. Liste veya oluşturma yanıtından alın.
Şablonu güncelleme
PATCH /api/v1/templates/{templateId}
Yalnızca değiştirmek istediğiniz alanları gönderin. Tasarım nesneleri kayıtlı tasarımla birleştirilir; bu nedenle kısmi bir styles geri kalanını korur. Şablondan önceden oluşturulmuş QR kodları, oluşturuldukları tasarımı korur.
string
gerekli
Şablonun kimliği.
string
Yeni ad; 1 ile 40 karakter arası.
object
Stil değişiklikleri; kayıtlı
styles ile birleştirilir.object
Çerçeve değişiklikleri; kayıtlı çerçeveyle birleştirilir.
object
Logo değişiklikleri; kayıtlı logoyla birleştirilir.
Şablonu silme
DELETE /api/v1/templates/{templateId}
Şablonu siler. Ondan oluşturulan QR kodları tasarımlarını korur.
string
gerekli
Şablonun kimliği.
Şablonu çoğaltma
POST /api/v1/templates/{templateId}/duplicate
<name> copy adında, kendi kimliğine ve serbestçe düzenleyebileceğiniz bağımsız bir tasarıma sahip bir kopya oluşturur. İstek gövdesi almaz. 201 Created ile yanıt verir.
string
gerekli
Kopyalanacak şablonun kimliği.
Sık karşılaşılan sorunlar
404 "QR template not found."
404 "QR template not found."
templateId, çalışma alanınızdaki hiçbir şablonla eşleşmiyor. Değeri Şablonları listeleme yanıtından alın.Şablon oluştururken veya güncellerken 422
Şablon oluştururken veya güncellerken 422
Bir tasarım alanı kataloglarla eşleşmiyor; örneğin bilinmeyen bir nokta türü, çerçeve veya önerilen logo. Mesaj alanın adını verir. Bkz. Özelleştirme.
QR kodu oluştururken 422 art_template_unsupported
QR kodu oluştururken 422 art_template_unsupported
Şablon markalı bir tasarım veya yapay zeka tasarımı kullanıyor. Bunun yerine
designKind değeri custom olan bir şablon uygulayın.