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.
Nasıl çalışır
1
Toplu oluşturmayı başlatın
Satırlarınızı JSON’dan oluşturma veya CSV dosyasından oluşturma ile gönderin. API, toplu oluşturma ve onun
id değeriyle birlikte 202 yanıtı verir.2
İlerlemesini sorgulayın
status değeri completed veya failed olana kadar birkaç saniyede bir Toplu oluşturmayı alma uç noktasını çağırın.3
Arşivi indirin
status değeri completed olduğunda, QR kodu görsellerinin ZIP dosyasını almak için Arşivi indirme uç noktasını çağırın.- Sınır. Toplu oluşturma başına en fazla 100 satır.
- Tek seferde bir tane. Çalışma alanı başına yalnızca bir toplu oluşturma çalışır. Biri çalışırken başka birini başlatmak, çalışan toplu oluşturmayı döndürür.
- Idempotency. Her istek bir
idempotencyKeygerektirir. Bir isteği aynı anahtar ve aynı gövdeyle tekrarlamak, önceden başlatılmış toplu oluşturmayı döndürür. Aynı anahtar farklı bir gövdeyle422döndürür. - Satırlar. Her satırın bir
nameve birurldeğeri olmalıdır. Bkz. Satırlar. - Plan. Toplu oluşturma Single QR planında kullanılamaz: istek
403 exceeded_limitdöndürür.
Satırlar
- Ad. QR kodunun başlığı olur. Baştaki ve sondaki boşluklar kırpılır ve 40 karaktere kısaltılır. Tekrarlanan adlara (büyük/küçük harf fark etmeksizin) bir numara eklenir:
Menu,Menu 2,Menu 3. - URL. Hedef olur.
example.com/menugibi gerçek bir alan adına sahip birhttpveyahttpsadresi olmalı ve boşluk içermemelidir. Şeması olmayan bir URL’yehttps://eklenir. - Boş satırlar. Ne adı ne de URL’si olan satırlar atlanır. Bunlardan yalnızca birini içeren satır reddedilir.
website QR kodudur. Bkz. QR türleri.
Başlıklar
string
gerekli
Bearer ve ardından API anahtarınız. Bkz. Kimlik doğrulama.string
JSON’dan oluşturma için
application/json, CSV dosyasından oluşturma için multipart/form-data.Toplu oluşturma nesnesi
string
Toplu oluşturmanın kimliği; örneğin
cm2k7x9qb0003ax8eb4f6gh2t.string
queued, processing, packaging veya completed. Başarısız olan veya iptal edilen bir toplu oluşturma rollingBack üzerinden failed durumuna geçer.string
Kaynak dosyanın adı.
integer
Satır sayısı.
integer
Şu ana kadar oluşturulan QR kodları.
integer
Şu ana kadar oluşturulan QR kodu görselleri.
integer
Genel ilerleme, 0 ile 100 arası. Oluşturma en fazla 40’a, görsel oluşturma en fazla 90’a kadar sürer, paketleme 95’tir ve
completed 100’dür.boolean
Çalışan bir toplu oluşturma 2 dakika boyunca ilerleme kaydetmediğinde
true. Sorgulamaya devam edin: Toplu oluşturmayı alma, takılan bir toplu oluşturmayı yeniden başlatır.object | null
status değeri failed olduğunda: code ve message. İptal edilen bir toplu oluşturmanın kodu cancelled_by_user olur. Başarısız bir toplu oluşturma geri alınır, bu nedenle QR kodlarının hiçbiri saklanmaz.string | null
status değeri completed olduğunda Arşivi indirme yolu.string
Başlangıç tarihi, ISO 8601.
string
Son güncelleme tarihi, ISO 8601.
string | null
Tamamlanma tarihi, ISO 8601.
string | null
Başarısız olma tarihi, ISO 8601.
Geçerli toplu oluşturmayı alma
GET /api/v1/bulk-qr-creations
Çalışma alanınızda hâlâ çalışan toplu oluşturmayı döndürür. Çalışan yoksa, kapatılana kadar en son tamamlanan toplu oluşturmayı (completed veya failed) döndürür: arşivini indirmek veya panelde kapatmak bunu sağlar. Aksi hâlde null döndürür. Yeniden başlatmanın ardından takibe devam etmek için kullanın.
JSON’dan oluşturma
POST /api/v1/bulk-qr-creations
Bir satır listesinden toplu oluşturma başlatır. 202 Accepted ile yanıt verir. Toplu oluşturma arka planda çalışır.
object[]
gerekli
Oluşturulacak QR kodları; en fazla 100. Her satır
{ "name": "...", "url": "..." } biçimindedir ve başka alan almaz. Bkz. Satırlar.object
gerekli
Her QR koduna uygulanan tasarım:
styles, frameOptions ve logoOptions; hepsi isteğe bağlıdır. Varsayılan tasarım için {} gönderin. Diğer alanlar reddedilir. Bkz. Özelleştirme.string
gerekli
Panelde gösterilen ve arşiv için kullanılan ad; 1 ile 255 karakter arası.
string
gerekli
Bu toplu oluşturma için kendi anahtarınız; 8 ile 100 karakter arası.
CSV dosyasından oluşturma
POST /api/v1/bulk-qr-creations/csv
JSON’dan oluşturma ile aynıdır, ancak satırları multipart/form-data olarak gönderilen bir CSV dosyası olarak alır. 202 Accepted ile yanıt verir.
Dosya en fazla 1.000.000 baytlık bir .csv olmalıdır. Başlık satırı tam olarak name,url olmalı, ardından en fazla 100 veri satırı gelmelidir. Bkz. CSV biçimi.
file
gerekli
CSV dosyası.
string
gerekli
JSON olarak serileştirilmiş tasarım nesnesi; örneğin
{"styles":{"dotsOptions":{"type":"rounded"}}}. Varsayılan tasarım için {} gönderin.string
gerekli
Bu toplu oluşturma için kendi anahtarınız; 8 ile 100 karakter arası.
string
Panelde gösterilen ve arşiv için kullanılan ad; en fazla 255 karakter. Varsayılanı yüklenen dosyanın adıdır.
Toplu oluşturmayı alma
GET /api/v1/bulk-qr-creations/{id}
Bir toplu oluşturmanın durumunu ve ilerlemesini döndürür. status değeri queued, processing veya packaging olduğu sürece sorgulayın. Arşiv hazır olduğunda downloadUrl görünür.
string
gerekli
Toplu oluşturmanın kimliği. Oluşturma veya geçerli toplu oluşturma yanıtından alın.
Toplu oluşturmayı iptal etme
DELETE /api/v1/bulk-qr-creations/{id}
Çalışan bir toplu oluşturmayı durdurur ve önceden oluşturduğu QR kodlarını siler. Geri alma işlemi istek sırasında çalışır; bu nedenle yanıtta normalde status değeri failed, error.code değeri cancelled_by_user olur. Zaten başarısız olmuş bir toplu oluşturmayı iptal etmek onu değiştirmeden döndürür.
string
gerekli
Toplu oluşturmanın kimliği.
Arşivi indirme
GET /api/v1/bulk-qr-creations/{id}/download
QR kodu başına bir adet 1024 px JPEG içeren, dosyaları satırlarına göre adlandırılmış bir ZIP arşivi döndürür: 001-Menu.jpg, 002-Wine list.jpg ve devamı. Arşiv sourceFilename değerine göre adlandırılır. status değeri completed olduğunda kullanılabilir. İndirme işlemi toplu oluşturmayı kapatır; böylece Geçerli toplu oluşturmayı alma onu döndürmeyi bırakır.
string
gerekli
Toplu oluşturmanın kimliği.
Sık karşılaşılan sorunlar
"contains an invalid HTTP(S) URL" ile 422
"contains an invalid HTTP(S) URL" ile 422
Mesaj satırı belirtir. Her URL,
example.com/menu gibi gerçek bir alan adına sahip bir http veya https adresi olmalıdır. Satırı düzeltin ve isteği yeniden gönderin.422 "CSV headers must be exactly: name,url."
422 "CSV headers must be exactly: name,url."
CSV’nin ilk satırı bu sırayla ve küçük harflerle, başka sütun olmadan
name,url olmalıdır.422 "This idempotencyKey was already used with a different request body."
422 "This idempotencyKey was already used with a different request body."
Anahtarlar farklı bir toplu iş için yeniden kullanılamaz. Yeni bir
idempotencyKey gönderin.409 "The bulk QR archive is not ready for download."
409 "The bulk QR archive is not ready for download."
Toplu oluşturma henüz tamamlanmadı.
status değeri completed olana kadar sorgulamaya devam edin.400 "Cannot cancel a finished bulk QR creation."
400 "Cannot cancel a finished bulk QR creation."
Toplu oluşturma zaten tamamlandı, bu nedenle geri alınamaz.
403 exceeded_limit
403 exceeded_limit
Çalışma alanınız, toplu oluşturmayı içermeyen Single QR planında. Planı yükseltin.
Yeni bir toplu oluşturma yerine eski bir tanesi döndü
Yeni bir toplu oluşturma yerine eski bir tanesi döndü
Çalışma alanınızda başka bir toplu oluşturma hâlâ çalışıyor veya bir
idempotencyKey değerini yeniden kullandınız. Bitmesini bekleyin veya yeni bir anahtar kullanın.